GET /companies/{id}

Summary

Get company

URL Parameters

Name	Type	Required	Description
id	string	Yes	Company identifier

Query Parameters

Name	Type	Required	Description
includeConfig	boolean	No	Include the company config object in the response

Request Body Fields

No request body is accepted for this endpoint.

Request Example

cURL

curl -X GET 'https://api.requidex.com/api/open/v1/companies/{id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/companies/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer <API_KEY>",
    Accept: "application/json",
  },
});

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/companies/{id}',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/companies/{id}", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Field	Type	Description
id	string	Company id
name	string	Company name
prefix	string	Company prefix used for reference generation
email	string	Company contact email
phone	object	Show child attributes countryCode string - Country dialing code number string - Phone number
companyNumber	string	Registered company number
active	boolean	Whether the company is active
projectCount	integer	Number of projects linked to this company
address	object	Show child attributes lineOne string lineTwo string city string region string country string code string - Postal code latitude number longitude number
finance	object	Company finance object. Show child attributes vat string - VAT number companyNumber string - Registered company number accountName string - Bank account name bankName string - Bank name accountNumber string - Bank account number sortCode string - Bank sort code utr string - UTR number cis object - CIS settings billing object - Billing address billingName string - Billing display name financeCompany string - Finance company name financeEmail object - Finance email and notification settings paymentTerms object - Payment terms configuration costs object - Cost component configuration Show child attributes markup object - Markup component Show child attributes name string key string value number basedOn array - Base component keys Show child attributes string - Cost component key sectors array - Sector ids linked to the component Show child attributes string - Sector id emp array - Employer cost components Show child attributes name string key string value number basedOn array - Base component keys Show child attributes string - Cost component key sectors array - Sector ids linked to the component Show child attributes string - Sector id
config	object	Company config object. Only returned when includeConfig=true. Show child attributes restrictions array - Restriction rules with type, item, label, description, affectedRoles, exceptionUsers, and enabled candidateRequirements object - Candidate requirement settings Show child attributes trade boolean available boolean verified boolean rtw boolean id boolean competencyMatrix boolean allowExpiredCompetency boolean cscsVerification boolean supplierOverride boolean rateUplifts array - Uplift rules with description, type, and uplift allowTsImport boolean mandatoryPo boolean tierRules array - Tier rules with value, tier, and isActive prefillTimesheets boolean timesheetActiveAssignments boolean invoiceBasis number mandatoryMfa boolean autoAssign boolean timesheetsAutoApproved boolean multiStageApproval object - Approval workflow settings Show child attributes req object Show child attributes status boolean totalStage number stageNames array timesheet boolean markupIncludeEmp boolean includeEmployerCosts boolean weekendDay string leadTimeWarning object Show child attributes enabled boolean days number email string timesheetAdjustment object - Timesheet adjustment permissions Show child attributes company boolean supplier boolean mspConfig object Show child attributes enabled boolean msps array billing boolean workerTsConfig object - Worker timesheet settings Show child attributes workerCanViewTs boolean workerCanAmendTs boolean workerTsNotification object Show child attributes email boolean sms boolean workerCanAllocateCostCodes boolean invoiceScheduling object Show child attributes enabled boolean frequency string dayOfWeek number dayOfMonth number time string mandatoryPoForApproval boolean invoiceCustomization object Show child attributes selfBilleeLabel string selfBillerLabel string selfBillInvoiceLabel string selfBillCreditNoteLabel string vatDisclaimer object with enabled and text showSiteName boolean logoSource string requiresPoForReq boolean assignmentCreated object Show child attributes enabled boolean preInductionUrl string notification object with email and sms supplierActions object - Supplier action permissions Show child attributes sds object Show child attributes required boolean company boolean supplier boolean sdc object Show child attributes required boolean company boolean supplier boolean kid object Show child attributes required boolean company boolean supplier boolean confirm object Show child attributes company boolean supplier boolean amendPayRateType object Show child attributes company boolean supplier boolean amendShift object Show child attributes company boolean supplier boolean amendTrade object Show child attributes company boolean supplier boolean markInvoicePaid object Show child attributes company boolean supplier boolean emailNotifications object with assignmentCreated, workerDocumentExpiration, and workerDocExpirationLiveOnly assignmentRequirements object - Assignment requirement permissions with sds, sdc, kid, and confirm objects matching the supplier action shape specificTimesheetApprovers object with enabled creditNotes object with displayAsNegativeOnExports workingRuleAgreement object Show child attributes enabled boolean accommodation object with enabled, dailyAmount, absence flags, preferredLabel, showInTotalsSeparately, and nested lodge settings enhancedUplifts object - Enhanced uplift settings Show child attributes enabled boolean mode string weekly object with threshold, enforce, and reduce days object - Day-by-day uplift configuration autoLinkPo boolean allowShiftBasedRequisitions boolean userInactivityMonths number costCodeAllocationRequired boolean preferredPhrasing object - Preferred terminology settings Show child attributes trade object with singular and plural worker object with singular and plural supplier object with singular and plural purchaseOrder object with singular and plural afpConfig object with enabled, reviewPeriodDays, hideInvoicesAndCreditNotes, and autoCreatePaymentNotice metaFields array - Meta field definitions
industry	string	Industry sector
createdAt	string	Creation timestamp
updatedAt	string	Last update timestamp

Response Example (200)

{
  "success": true,
  "data": {
    "id": "67bc36db80a1616ec3f47001",
    "name": "Requidex Construction Ltd",
    "prefix": "RCL",
    "email": "hello@requidex.com",
    "phone": {
      "countryCode": "+44",
      "number": "1234567890"
    },
    "companyNumber": "12345678",
    "active": true,
    "projectCount": 12,
    "address": {
      "lineOne": "1 Builder Way",
      "lineTwo": "Floor 2",
      "city": "London",
      "region": "Greater London",
      "country": "United Kingdom",
      "code": "EC1A 1BB",
      "latitude": 51.5074,
      "longitude": -0.1278
    },
    "finance": {
      "vat": "GB123456789",
      "accountName": "Requidex Construction Ltd",
      "bankName": "Example Bank",
      "accountNumber": "12345678",
      "sortCode": "12-34-56",
      "paymentTerms": {
        "days": 30,
        "term": "days"
      }
    },
    "industry": "construction",
    "createdAt": "2025-01-10T12:00:00.000Z",
    "updatedAt": "2026-02-20T14:03:12.111Z"
  }
}

Errors

HTTP Status	Description
400	Invalid or missing company id
401	Missing, invalid, revoked, or expired API key
403	Forbidden due to scope, IP restrictions, or company access
404	Company not found
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Unexpected internal error