/teams

Returns a list of Team objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	const pageableResponse = await client.ticketing.teams.list({
5	createdAfter: new Date("2024-01-15T09:30:00.000Z"),
6	createdBefore: new Date("2024-01-15T09:30:00.000Z"),
7	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
8	includeDeletedData: true,
9	includeRemoteData: true,
10	includeShellData: true,
11	modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
12	modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
13	pageSize: 1,
14	remoteId: "remote_id"
15	});
16	for await (const item of pageableResponse) {
17	console.log(item);
18	}
19
20	// Or you can manually iterate page-by-page
21	let page = await client.ticketing.teams.list({
22	createdAfter: new Date("2024-01-15T09:30:00.000Z"),
23	createdBefore: new Date("2024-01-15T09:30:00.000Z"),
24	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
25	includeDeletedData: true,
26	includeRemoteData: true,
27	includeShellData: true,
28	modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
29	modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
30	pageSize: 1,
31	remoteId: "remote_id"
32	});
33	while (page.hasNextPage()) {
34	page = page.getNextPage();
35	}
36
37	// You can also access the underlying response
38	const response = page.response;

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "17a54124-287f-494d-965e-3c5b330c9a68",
7	"remote_id": "19202938",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"name": "Platform",
11	"description": "Platform and Integrations Team",
12	"remote_was_deleted": true,
13	"field_mappings": {
14	"organization_defined_targets": {
15	"custom_key": "custom_value"
16	},
17	"linked_account_defined_targets": {
18	"custom_key": "custom_value"
19	}
20	},
21	"remote_data": [
22	{
23	"path": "/platform-endpoint"
24	}
25	]
26	}
27	]
28	}

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration