Retrieve

GET

https://host.com/contracts/:contract_id/

GET

/contracts/:contract_id/

1 curl /contracts/contract_id/ \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "data": {
3     "contract_id": "string",
4     "freelancer": {
5       "freelancer_id": "string",
6       "first_name": "string",
7       "last_name": "string",
8       "full_name": "string",
9       "email": "string",
10       "date_of_birth": "2023-01-15",
11       "legal_name": "string"
12     },
13     "client": {
14       "client_id": "string",
15       "name": "string"
16     },
17     "client_contact": {
18       "client_contact_id": "string",
19       "custom_fields": [
20         {
21           "name": "string",
22           "value": "string"
23         }
24       ]
25     },
26     "hirers": [
27       {
28         "hirer_id": "string",
29         "first_name": "string",
30         "last_name": "string",
31         "full_name": "string",
32         "email": "string"
33       }
34     ],
35     "title": "string",
36     "job_title": "string",
37     "description": "string",
38     "start_date": "2023-01-15",
39     "end_date": "2023-01-15",
40     "actual_end_date": "string",
41     "rate": {
42       "value": "string",
43       "unit": "string",
44       "currency": "AUD"
45     },
46     "work_time_type": "string",
47     "fee_schedule": {
48       "periods": [
49         {
50           "effective_from": "2023-01-15",
51           "fees": [
52             {
53               "percentage": "string",
54               "value": "string",
55               "currency": "string",
56               "name": "string"
57             }
58           ],
59           "total_fees": {
60             "currency": "string",
61             "value": "string"
62           },
63           "total_cost": {
64             "currency": "string",
65             "value": "string"
66           }
67         }
68       ]
69     },
70     "notice_period_days": 1,
71     "work_location": "string",
72     "minutes_in_working_day": 1,
73     "custom_fields": [
74       {
75         "name": "string",
76         "value": "string"
77       }
78     ],
79     "spend_request": {
80       "spend_request_id": "string",
81       "url": "string",
82       "external_id": "string",
83       "title": "string",
84       "description": "string",
85       "amount": "string",
86       "amount_type": "DAY_RATE",
87       "currency": "AUD",
88       "custom_fields": [
89         {
90           "name": "string",
91           "value": "string"
92         }
93       ]
94     },
95     "renewal_meta": {
96       "is_initial_contract": true,
97       "is_renewal": true,
98       "has_subsequent_renewal": true,
99       "initial_contract_id": "string",
100       "parent_contract_id": "string",
101       "renewal_chain_position": 1,
102       "renewal_chain": [
103         "string"
104       ]
105     }
106   }
107 }

Retrieve a specific contract by PublicID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contract_idstringRequiredformat: "^ct_c[a-z0-9]{24}$"

Response

dataobject

The contract object. This objects represents a contract on the YunoJuno platform between a client and a freelancer.