Get Match Operational Structures

GET /operational-structures
Bearer auth

This API retrieves all Match operational structures.

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • id string

      The operational structure id.

    • name string

      The operational structure name.

    • hierarchy string

      The operational structure hierarchy.
  • 401 application/json

    Authentication Error. Invalid credentials.

    Hide response attributes Show response attributes object
  • 403

    Authorization Error. Invalid role for request.

GET /operational-structures 
curl \
 --request GET 'https://localhost:8080/operational-structures' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "id": 1,
      "name": "Accounts payable",
      "hierarchy": "Balance Sheet->Liabilities->Current Liabilities->Accounts Payable"
    },
    {
      "id": 2,
      "name": "Accounts Receivable",
      "hierarchy": "Balance Sheet->Assets->Current Assets->Accounts Receivable"
    },
    {
      "id": 3,
      "name": "Deposits",
      "hierarchy": "Balance Sheet->Assets->Other Assets->Deposits"
    }
  ],
  "totalRecords": 3
}
Response examples (401) 
{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}