Skip to main content
GET
/
organisation
/
information
Get organisation information
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/information \
  --header 'X-Auth-Token: <api-key>'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "name": {
        "legalName": "Acme Corporation Ltd",
        "tradingName": "Acme Corp"
      },
      "organisationType": "LimitedCompany",
      "companyRegistrationNumber": "12345678",
      "businessType": "LimitedCompany",
      "registredOfficeAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "correspondenceAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "companyContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "primaryContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "organisationId": "org_123",
      "createdBy": "user_123",
      "createdDate": "2025-01-01T00:00:00Z",
      "updatedBy": "user_456",
      "updatedDate": "2025-01-02T00:00:00Z"
    },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

Response

The organisation information was retrieved

message
object
content
object
validationIssues
object[]
messageToken
string