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 scopeList consultation service itemsCreate job scope change requestApprove 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

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodProvide a personal refund methodProvide a business refund method

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

List Consultation Service Items

List consultation service items.

The list consultation items endpoint allows you to retrieve a paginated list of consultation services in your workspace.

Endpoint

Method	Url
`GET`	`/v1.0/scope_change/consultations`

Request Parameters

filter

•

string

The filter string. See the Filtering section for details on member filtering. Additionally, Check the filtering documentation for more information.

page_size

•

number

The page size for search result pagination. If not provided, the service will default to 50 items.

page_token

•

string

The page to fetch. This would be the next_page_token value returned from the previous request if any.

Sample Request

Copied
1curl 'https://api.worklayer.com/v1.0/scope_change/consultations' \
2  -H 'Authorization: Bearer {token}'

Response

data

•

list

The consultation service items belonging to that workspace.

next_page_token

•

string

The pagination token to retrieve the next page of results. If the value is "", it means no further results for the request.

Sample Response

Copied
1{
2  "data": [
3    {
4      "id": "ea7dd97b-a485-41b5-9cca-a607915b2f80",
5      "name": "Consultation (1 Hour)",
6      "description": "Consultation (1 Hour)",
7      "length_in_minutes": 60
8    },
9    {
10      "id": "3bcc8382-cdd5-4895-8ce2-b271955454c6",
11      "name": "Consultation (15 Minutes)",
12      "description": "Consultation (15 Minutes)",
13      "length_in_minutes": 15
14    },
15    {
16      "id": "b1b66b75-c23e-4fc4-b24b-924f25dfd2d0",
17      "name": "Consultation (30 Minutes)",
18      "description": "Consultation (30 Minutes)",
19      "length_in_minutes": 30
20    }
21  ],
22  "next_page_token": "YjFiNjZiNzUtYzIzZS00ZmM0LWIyNGItOTI0ZjI1ZGZkMmQwLDIwMjQtMDUtMDlUMTUlM2EzOCUzYTMxLjMxODk4MjAlMmIwMCUzYTAw"
23}

Consultation Service Item

•

guid

The unique identifier of the consultation item.

name

•

string

The name of the consultation item.

description

•

string

The description of the consultation item.

length_in_minutes

•

numeric

The duration of the service in minutes.

Filtering

The following fields are supported:

Field	Comparator	Description	Example
`id`	`=`	The consultation item ID.	`id="22b1b66b75-c23e-4fc4-b24b-924f25dfd2d0"`
`length`	`=`	The consultation duration in minutes.	`length=30`

Sample Request with Filters

Copied
1curl 'https://api.worklayer.com/v1.0/scope_change/consultations?filter="id=22b1b66b75-c23e-4fc4-b24b-924f25dfd2d0"' -H
2'Authorization: Bearer {token}'

Next steps

Last updated on December 9, 2024