Metadata - Company

Endpoint Description

The data export endpoint provides a snapshot view of a the current company meta data. A snapshot is a single point in time. This endpoint is paginated with a default of 1000 records per page. Query string parameters: company.id, company.created, company.modified, company.name, company.type

Request Information

URI

Authorize GEThttps://api20.takeuchi-us.com/Data/v1/Companies/{pageNumber}

URI Parameters

Name Description Type Additional Information
pageNumber Navigation is controlled by the page number parameter. string Required

Header Parameters

Key Value Description Requirements
Authorization Bearer *Token generated from Connect endpoint. Authorization is required to access this endpoint. Required
Accept */* | application/xml | application/json By default responses will be "application/json". Optional

Body Parameters

None (Empty)

Response Information

Resource Description

Response will be defined by this following format, and can either be XML or JSON format.

CompanyData

Name Description Type Additional Information
Links Links are used to describe the meta data about call. Each link contains a relationship (rel) and a hyper-link (href). Collection of Links Single element entry may not contain links.
Entries Contains data points related to the company's meta data. Collection of Entry Single element entries will contain a single element.
Version Declaration Version specifies the version of the response conforms. string
ExportTime The snapshot time is the date and time at which the snapshot of the data was created. string Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ

Response Formats

<CompanyData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="sample string 1" xmlns="export">
  <Links>
    <Links>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
    </Links>
    <Links>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
    </Links>
  </Links>
  <Entries>
    <Entry>
      <Company>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <ReferenceId>sample string 3</ReferenceId>
        <CustomerNumber>sample string 4</CustomerNumber>
        <CreationDate>2025-04-19T10:14:05.254323-04:00</CreationDate>
        <ModifiedDate>2025-04-19T10:14:05.254323-04:00</ModifiedDate>
        <Type>sample string 5</Type>
        <Region>sample string 6</Region>
      </Company>
      <Reference>
        <Id>sample string 1</Id>
        <Provider>sample string 2</Provider>
      </Reference>
    </Entry>
    <Entry>
      <Company>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <ReferenceId>sample string 3</ReferenceId>
        <CustomerNumber>sample string 4</CustomerNumber>
        <CreationDate>2025-04-19T10:14:05.254323-04:00</CreationDate>
        <ModifiedDate>2025-04-19T10:14:05.254323-04:00</ModifiedDate>
        <Type>sample string 5</Type>
        <Region>sample string 6</Region>
      </Company>
      <Reference>
        <Id>sample string 1</Id>
        <Provider>sample string 2</Provider>
      </Reference>
    </Entry>
  </Entries>
  <ExportTime>2025-04-19T14:14:05Z</ExportTime>
</CompanyData>
Return