List Business Profiles

Returns a list of business profiles for a user.

This endpoint retrieves a paginated list of all business 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/business-profiles`

Path Parameters

user_id

•

string

required

The unique identifier of the user whose business 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/550e8400-e29b-41d4-a716-446655440000/business-profiles?page_size=10' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

Array of business profile resources.

total_size

•

integer

Total number of business 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": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
5      "version": 1,
6      "workspace_id": "ws_12345",
7      "owner_user_id": "550e8400-e29b-41d4-a716-446655440000",
8      "create_time": "2024-06-15T14:30:00Z",
9      "update_time": "2024-06-15T14:30:00Z",
10      "business_info": {
11        "business_name": "Tech Solutions LLC",
12        "date_of_incorporation": "03/15/2022",
13        "employer_identification_number": "98-7654321"
14      },
15      "contact_info": {
16        "email": "info@techsolutions.com",
17        "phone_number": "+1-305-555-0100",
18        "address": {
19          "address_line_1": "456 Innovation Way",
20          "address_line_2": null,
21          "city": "Miami",
22          "region": "FL",
23          "postal_code": "33130",
24          "country": "United States"
25        }
26      }
27    },
28    {
29      "id": "7d8e9f10-2c3b-4a5c-6d7e-8f9a0b1c2d3e",
30      "version": 3,
31      "workspace_id": "ws_12345",
32      "owner_user_id": "550e8400-e29b-41d4-a716-446655440000",
33      "create_time": "2024-01-01T10:00:00Z",
34      "update_time": "2024-05-20T16:45:00Z",
35      "business_info": {
36        "business_name": "Acme Corporation",
37        "date_of_incorporation": "01/01/2020",
38        "employer_identification_number": "12-3456789"
39      },
40      "contact_info": {
41        "email": "contact@acme.com",
42        "phone_number": "+1-555-555-5555",
43        "address": {
44          "address_line_1": "123 Business Ave",
45          "address_line_2": "Suite 100",
46          "city": "Miami",
47          "region": "FL",
48          "postal_code": "33134",
49          "country": "United States"
50        }
51      }
52    }
53  ],
54  "total_size": 2
55}

Errors

400: Invalid request parameters
403: You're not allowed to list business profiles for this user

Next steps

Last updated on June 19, 2025