List Dependent Profiles

Retrieve a list of dependent profiles for a user.

This endpoint retrieves a paginated list of all dependent profiles associated with a specific user. The profiles are returned in descending order by creation time.

Endpoint

Method	Url
`GET`	`/v1.0/users/:user_id/dependent-profiles`

Path Parameters

user_id

•

string

required

The unique identifier of the user whose dependent profiles are being retrieved.

Query Parameters

page_size

•

integer

The number of items to return per page. Default is 50, maximum is 100.

page_token

•

string

Token for retrieving the next page of results. Obtained from the next_page_token field in the previous response.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/users/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/dependent-profiles?page_size=10' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

Array of dependent profile resources.

total_size

•

integer

Total number of dependent profiles for this user across all pages.

next_page_token

•

string

Token to retrieve the next page of results. If not present, there are no more pages.

Sample Response

Copied
1{
2  "data": [
3    {
4      "id": "e7b513b9-d795-4475-9382-96710ca61622",
5      "version": 1,
6      "owner_user_id": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
7      "personal_info": {
8        "first_name": "Alice",
9        "middle_initial": "R",
10        "last_name": "Doe",
11        "date_of_birth": "01/01/2010",
12        "personal_taxpayer_identification_number": null
13      },
14      "relationship": "Child",
15      "create_time": "2024-01-01T00:00:00Z",
16      "update_time": "2024-01-01T00:00:00Z"
17    },
18    {
19      "id": "550e8400-e29b-41d4-a716-446655440001",
20      "version": 1,
21      "owner_user_id": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
22      "personal_info": {
23        "first_name": "Bob",
24        "middle_initial": null,
25        "last_name": "Doe",
26        "date_of_birth": "06/15/2012",
27        "personal_taxpayer_identification_number": null
28      },
29      "relationship": "Child",
30      "create_time": "2024-01-01T00:00:00Z",
31      "update_time": "2024-01-01T00:00:00Z"
32    }
33  ],
34  "total_size": 2,
35  "next_page_token": "eyJvZmZzZXQiOjEwfQ=="
36}

Errors

403: you're not allowed to list dependent profiles for this user

Next steps

Last updated on June 18, 2025