List contract amendments | Deel

Retrieve amendments of a contract Token scopes: contracts:read, contracts:write

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequiredformat: "uuid"

Unique identifier of the contract

Query parameters

statuseslist of enumsOptional

Filter by work statement status.

sign_statuseslist of enumsOptional

Filter by work statement sign status.

Allowed values:

limitintegerOptional1-100Defaults to 20

Maximum number of work statements to return.

cursorstringOptional

Cursor for pagination.

Response

Successful operation.

datalist of objects

List of work statements (amendments).

cursorstring or null

Cursor for the next page of results.

has_moreboolean

Indicates if there are more work statements available.

total_countinteger

Total number of work statements matching the filters.

1	curl -G https://api.letsdeel.com/rest/v2/contracts/123e4567-e89b-12d3-a456-426614174000/amendments \
2	-H "Authorization: Bearer <token>" \
3	-d statuses=PENDING \
4	-d statuses=ACTIVE \
5	-d sign_statuses=PENDING \
6	-d sign_statuses=APPROVED \
7	-d limit=10 \
8	-d cursor=eyJjcmVhdGVkX2F0IjoiMjAyNC0wMS0xNVQxMDowMDowMC4wMDBaIiwicHVibGljX2lkIjoiYWJjMTIzIn0

1	{
2	"data": [
3	{
4	"id": "123e4567-e89b-12d3-a456-426614174000",
5	"status": "ACTIVE",
6	"created_at": "2024-01-15T10:00:00.000Z",
7	"updated_at": "2024-01-20T14:30:00.000Z",
8	"sign_status": "APPROVED",
9	"rate": 5000,
10	"scale": "HOURLY",
11	"contract_name": "Software Development Contract",
12	"contract_type": "ongoing_time_based",
13	"currency_code": "USD",
14	"effective_date": "2024-02-01"
15	}
16	],
17	"cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0wMS0xNVQxMDowMDowMC4wMDBaIiwicHVibGljX2lkIjoiZGVmNDU2In0",
18	"has_more": true,
19	"total_count": 150
20	}

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication