Sign in

v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Listar Requisitos

Listar Requisitos de um Envelope

get/envelopes/{envelope_id}/requirements

Path parameters

envelope_idstring required

ID do envelope ao qual deseja listar os requisitos

Headers

Authorizationstring required

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json'

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "data": [
    {
      "id": "cc13fa02-c4f1-45ba-9136-ea0d751a5ec1",
      "type": "requirements",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/envelopes/d94c0347-e1e7-42d6-af99-f5f4c68392df/requirements/cc13fa02-c4f1-45ba-9136-ea0d751a5ec1"
      },
      "attributes": {
        "action": "agree",
        "role": "party",
        "created": "2024-03-20T14:36:47.865-03:00",
        "modified": "2024-03-20T14:36:47.865-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 2
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/envelopes/d94c0347-e1e7-42d6-af99-f5f4c68392df/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/envelopes/d94c0347-e1e7-42d6-af99-f5f4c68392df/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}