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

Member

Resource representing a member belonging to a workspace.

The Member resource contains information about a user specifically configured to your workspace, such as any custom_fields.

Endpoints

Method	Url
`GET`	`/v1.0/members/{user_id}`
`GET`	`/v1.0/members`
`POST`	`/v1.0/members`
`PATCH`	`/v1.0/members/{user_id}`

Properties

email

The email of the member.

user_id

The user ID of the member.

create_time

The time the user became a member of the workspace.

update_time

The time the user was last updated as a member of the workspace.

custom_fields

Any custom metadata the member may have configured in the workspace.

Copied
1{
2  "email": "tony@stark.com",
3  "user_id": "1232-1232-1232-1232-1232",
4  "create_time": "2020-01-01T00:00:00Z",
5  "update_time": "2020-01-01T00:00:00Z",
6  "custom_fields": [
7    "key": {
8      "string_value": "value",
9      "boolean_value": "value",
10      "number_value": "value"
11    }
12  ]
13}

Next steps

Last updated on October 6, 2022

Privacy Policy Terms & Conditions© 2024 Taxfyle