---
agentTools:
  projectIndex: https://uspacy.readme.io/llms.txt
---

# Get requisites list

Returns a paginated list of company requisites (legal details, tax IDs, etc.).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "CRM service",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://{domain}.uspacy.ua",
      "description": "Ukrainian server"
    },
    {
      "url": "https://{domain}.uspacy.eu",
      "description": "EU server"
    },
    {
      "url": "https://{domain}.uspacy.com.br",
      "description": "Brazilian server"
    },
    {
      "url": "https://{domain}.uspacy.com",
      "description": "International server"
    }
  ],
  "tags": [
    {
      "name": "requisites",
      "description": "Requisites, bank requisites, and templates"
    }
  ],
  "paths": {
    "/crm/v1/requisites": {
      "get": {
        "tags": [
          "requisites"
        ],
        "summary": "Get requisites list",
        "description": "Returns a paginated list of company requisites (legal details, tax IDs, etc.).",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/list"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Requisite"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "meta": {
                          "$ref": "#/components/schemas/Meta"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Access token is missing or invalid"
      }
    },
    "parameters": {
      "page": {
        "name": "page",
        "in": "query",
        "description": "Current page",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 1
        },
        "example": 1
      },
      "list": {
        "name": "list",
        "in": "query",
        "description": "How many items should be per page",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 20
        },
        "example": 10
      }
    },
    "schemas": {
      "Meta": {
        "type": "object",
        "properties": {
          "currentPage": {
            "type": "integer",
            "example": 1
          },
          "from": {
            "type": "integer",
            "example": 1
          },
          "lastPage": {
            "type": "integer",
            "example": 1
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "example": null
                },
                "label": {
                  "type": "string",
                  "example": "Previous"
                },
                "active": {
                  "type": "boolean",
                  "example": false
                }
              }
            }
          },
          "path": {
            "type": "string",
            "example": "https://domain.uspacy.ua/crm/v1/entities/leads"
          },
          "perPage": {
            "type": "integer",
            "example": 20
          },
          "to": {
            "type": "integer",
            "example": 2
          },
          "total": {
            "type": "integer",
            "example": 2
          }
        }
      },
      "Field": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Source"
          },
          "code": {
            "type": "string",
            "example": "source"
          },
          "required": {
            "type": "boolean",
            "example": false
          },
          "editable": {
            "type": "boolean",
            "example": true
          },
          "show": {
            "type": "boolean",
            "example": true
          },
          "hidden": {
            "type": "boolean",
            "example": false
          },
          "multiple": {
            "type": "boolean",
            "example": false
          },
          "fieldSectionId": {
            "type": "integer",
            "example": 11
          },
          "default_value": {
            "type": "string",
            "example": "value"
          },
          "tooltip": {
            "type": "string",
            "example": "example"
          },
          "type": {
            "type": "string",
            "example": "entity_reference"
          },
          "entity_reference_id": {
            "type": "integer",
            "example": 123
          },
          "sort": {
            "type": "integer",
            "example": 90
          }
        }
      },
      "Requisite": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "seal_picture": {
            "type": "number"
          },
          "sign_picture": {
            "type": "number"
          },
          "template_name": {
            "type": "string"
          },
          "references_relations": {
            "type": "array",
            "items": {
              "type": "number",
              "description": "Id of parent entity where requisite attach to child entity"
            }
          },
          "is_basic": {
            "type": "boolean"
          },
          "id": {
            "type": "number"
          },
          "template_id": {
            "type": "integer"
          },
          "region": {
            "$ref": "#/components/schemas/Region"
          },
          "fields": {
            "description": "Fields list",
            "type": "object",
            "properties": {
              "list": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Field"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "datetime",
                            "string",
                            "integer",
                            "boolean",
                            "file"
                          ]
                        }
                      }
                    }
                  ]
                }
              },
              "values": {
                "type": "object",
                "properties": {
                  "field_code": {
                    "enum": [
                      "string",
                      "array",
                      "object"
                    ],
                    "description": "Field code => field value"
                  }
                }
              }
            }
          },
          "bank_requisites": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BankRequisite"
            }
          }
        }
      },
      "Region": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "image": {
            "type": "number"
          },
          "id": {
            "type": "number"
          }
        }
      },
      "BankRequisite": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "created_by": {
            "type": "number"
          },
          "requisite_id": {
            "type": "number",
            "required": true
          },
          "name": {
            "type": "string"
          },
          "is_basic": {
            "type": "boolean"
          },
          "fields": {
            "type": "object",
            "properties": {
              "list": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Field"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "string"
                          ]
                        }
                      }
                    }
                  ]
                }
              },
              "values": {
                "type": "object",
                "properties": {
                  "field_code": {
                    "enum": [
                      "string",
                      "array",
                      "object"
                    ],
                    "description": "Field code => field value"
                  }
                }
              }
            }
          },
          "references_relations": {
            "type": "array",
            "items": {
              "type": "number",
              "description": "Id of parent entity where requisite attach to child entity"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 105,
      "1": 145,
      "2": 108,
      "3": 28,
      "4": 165,
      "5": 162,
      "6": 20,
      "7": 148,
      "8": 43,
      "9": 242,
      "10": 235,
      "11": 56
    }
  }
}
```