Company

All data accessed through Helix TeamHub APIs is scoped under a company. As a Helix TeamHub user, you only have access to your own company.

• Attributes
• Child objects
• Operations
  • GET /company
  • PUT /company

Attributes

id

A URL-friendly identifier for the company.

• Type: string
• Unique: true
• Required: true
• Minimum length: 2
• Maximum length: 100
• Allowed characters: a-z, A-Z, 0-9, -, _

name

The human-readable name of the company.

• Type: string
• Required: true
• Minimum length: 2
• Maximum length: 100

display_name

Same as the name of the company or value of the id if the name is not set.

• Type: string

Child objects

The following child objects can be attached to the company returned, to eliminate the need for requesting them separately:

Object	Attribute
User	projects
Collaborator	collaborators
Repository	repositories
Project	projects

For example, to get all of the company's users in full and the number of repositories it has, attach include=users&count=repositories to your GET request.

See the child object API documentation for a description of the possible operations.

Operations

GET /company

Returns a company object.

Example Request

curl -X GET \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  https://helixteamhub.cloud/api/company

Example Response

{
  "api_status": 200,
  "api_timestamp": "2013-06-13T12:53:47Z",
  "id": "eficode",
  "created_at": "2011-08-23T21:32:24Z",
  "updated_at": "2013-05-29T10:47:05Z",
  "name": "Eficode",
  "display_name": "Eficode"
}

PUT /company

Updates a company. Returns the updated company object.

Example Request

curl -X PUT \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Eficode Oy" }' \
  https://helixteamhub.cloud/api/company

Example Response

{
  "api_status": 200,
  "api_timestamp": "2013-06-13T13:21:32Z",
  "id": "eficode",
  "created_at": "2011-08-23T21:32:24Z",
  "updated_at": "2013-06-13T13:21:32Z",
  "name": "Eficode Oy",
  "display_name": "Eficode Oy"
}