Getting a list of organizations

The method allows you to get a list of organizations

Getting a list of organizations

post
Header parameters
x-api-public-keystringoptional

Public API-key

x-api-signaturestringoptional

Signing the request body with a private API-key

Content-typestringoptional

Request content type

Example: application/json
Body

Request body of the list of organizations

userIdstringoptional

User ID

Example: 7deb62fb-88a9-4430-9467-eee7d955cb82
limitintegeroptional

Number of elements per page

offsetintegeroptional

Number of items to skip

Responses
application/json
objectoptional

Successful response

post
POST /partner/api/get-user-organizations HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "userId": "7deb62fb-88a9-4430-9467-eee7d955cb82",
  "limit": 1,
  "offset": 1
}
200Success
{
  "success": true,
  "response": [
    {
      "id": "a495e2cc-a997-4498-bb19-c4006877eaa0",
      "name": "custom name",
      "createdAt": "2024-12-25T14:35:23.084Z"
    }
  ]
}

Last updated