Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Aptly App Company API
version: '1.0'
description: 'The Aptly API lets you read and write cards on any Aptly board from external systems.
All requests require an API key passed as the `x-token` header.
API keys are scoped to your company and work across all boards.
'
servers:
- url: https://core-api.getaptly.com
description: Production
security:
- ApiKeyHeader: []
tags:
- name: Company
paths:
/api/company/info:
get:
summary: Get company info
description: Returns the name, address, contact details, and logo URL for the company associated with the API key.
operationId: getCompanyInfo
tags:
- Company
security:
- ApiKeyHeader: []
responses:
'200':
description: Company information.
content:
application/json:
schema:
type: object
properties:
name:
type:
- string
- 'null'
address:
type: object
properties:
street:
type:
- string
- 'null'
city:
type:
- string
- 'null'
state:
type:
- string
- 'null'
zip:
type:
- string
- 'null'
phone:
type:
- string
- 'null'
phone2:
type:
- string
- 'null'
website:
type:
- string
- 'null'
logo:
type:
- string
- 'null'
description: Absolute URL to the company logo thumbnail.
'401':
description: Invalid or missing API key.
components:
securitySchemes:
ApiKeyHeader:
type: apiKey
in: header
name: x-token
DelegateToken:
type: apiKey
in: header
name: Authorization
description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'
PartnerBearer:
type: http
scheme: bearer
description: 'Partner token. Format: `Authorization: Bearer <token>`'