GET /agreements/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- files object | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object array-2 array boolean-3 boolean integer-4 integer number-5 number string-6 string
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
- filesRequired boolean | null Required
  
  Files required
  
  Default value is false.
- id integer(int32)
  
  Id
- instructions string | null
  
  Instructions
- name string Required
  
  Name
- status string | null Required
  
  Status
  
  Values are draft, active, or archived. Default value is draft.
- updatedAt string(date-time)
  
  Updated at

curl \
 -X GET http://api.example.com/v1/agreements/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "files": {},
  "filesRequired": false,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}

GET /agreements/{id}.json

Path parameters

Responses

files object | array | boolean | integer | number | string Required