Skip to content

API Documentation

ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Creating Workspace Members

Create members belonging to your workspace.

The create members endpoint allows you to create new members in your workspace.

Endpoint

Method	Url
`POST`	`/v1.0/members`

Request Parameters

email

•

string

required

The member's unique email.

given_name

•

string

required

The member's given name.

family_name

•

string

required

The member's family name.

phone_number

•

string

The member's phone number.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/members' \
2-H 'Authorization: Bearer {token}' \
3-d '{ "email": "tony@stark.com", "given_name": "Tony", "family_name": "Stark" }'

Response

An instance of member resource.

Sample Response

Copied
1{
2    "email": "tony@stark.com",
3    "user_id": "a6e5ea2f-7d96-4852-9f46-2383dfd572f7",
4    "create_time": "2022-04-11T15:18:00.701Z",
5    "update_time": "2022-04-11T15:18:00.701Z",
6    "custom_fields": []
7}

Errors

Forbidden: API Client cannot create members.
Unauthorized: API Client does not have valid credentials.
BadRequest: Either required properties are missing, or there was a malformed request.

Last updated on October 6, 2022

Privacy Policy Terms & Conditions© 2024 Taxfyle