Reo.dev APIS (1.0.0)
Download OpenAPI specification:Download
Welcome to the Reo.dev API Documentation!
Our APIs empower you to seamlessly fetch data from our product and integrate it into your existing systems.
To get started, please reach out to Reo.Dev support team to obtain your unique API_KEY. If you're an admin, contact them to facilitate this process.
Our APIs offer access to a variety of data, including account information and developer data, allowing you to tailor your integration to suit your specific needs.
api_key
To authenticate requests to the integration.reo.dev API, include an API key in the request header with the key "x-api-key". Each client accessing the API will be assigned a unique API key.
x-api-keyList of segments
query Parameters
| page | integer Page number of Segments List |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "name": "High Developer activity",
- "segment_id": "47e9bfb4-2f39-4131-b44c-fb3ef9fd43ca",
- "type": "ACCOUNT",
- "description": "This is segment for account with High developer activity in last 30 Days"
}
], - "total_pages": 0,
- "next_page": 0,
- "request_id": "string"
}List of accounts
path Parameters
| segment_id required | string Example: 47e9bfb4-2f39-4131-b44c-fb3ef9fd43ca Unique ID of the segment |
query Parameters
| page | integer Page number of Accounts List |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "country": "India",
- "last_activity_date": "2024-04-12 12:04:11",
- "account_domain": "microsoft.com",
- "first_activity_date": "2024-03-21 12:04:11",
- "account_name": "Microsoft",
- "active_developers_count": 12,
- "developer_activity": "HIGH",
- "customer_fit": "STRONG",
- "id": "f7da3b26-1857-45cd-b5f1-9c62eec5d474"
}
], - "total_pages": 0,
- "next_page": 0,
- "request_id": "string"
}Get account activities
path Parameters
| account_id required | string Example: f7da3b26-1857-45cd-b5f1-9c62eec5d474 Unique ID of an account |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "activity_type": "Fork",
- "actor": "string",
- "activity_source": "GITHUB",
- "page": "string",
- "copied_text": "string",
- "developer_designation": "Software Developer",
- "country": "India",
- "activity_date": "2024-04-12 12:04:11",
- "source_type": "string",
- "developer_id": "f6ffa648-61bd-4d62-9fee-7c87623b66ca"
}
], - "request_id": "string"
}Get account developers
path Parameters
| account_id required | string Example: f7da3b26-1857-45cd-b5f1-9c62eec5d474 Unique ID of an account |
query Parameters
| page | integer Page number of a account Developers |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "f6ffa648-61bd-4d62-9fee-7c87623b66ca",
- "developer_name": "Micheal John Bevan",
- "developer_business_email": "michael_bevan@reo.dev",
- "latest_activity": 1681629970000,
- "first_activity": 1681629970000
}
], - "total_pages": 0,
- "next_page": 0,
- "request_id": "string"
}List of developers
path Parameters
| segment_id required | string Example: 47e9bfb4-2f39-4131-b44c-fb3ef9fd43ca Unique ID of the segment |
query Parameters
| page | integer Page number of Developers List |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "f6ffa648-61bd-4d62-9fee-7c87623b66ca",
- "developer_name": "Micheal John Bevan",
- "developer_business_email": "michael_bevan@reo.dev",
- "latest_activity": 1681629970000,
- "first_activity": 1681629970000
}
], - "total_pages": 0,
- "next_page": 0,
- "request_id": "string"
}Get developer Activities
path Parameters
| developer_id required | string Example: f6ffa648-61bd-4d62-9fee-7c87623b66ca Unique ID of a developer |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "account_id": "f7da3b26-1857-45cd-b5f1-9c62eec5d474",
- "activity_type": "COPY_COMMAND",
- "actor": "d075063a5739265e216a86551cdbd1b7",
- "source_type": "PRODUCT_JS",
- "source": "Memgraph Cloud",
- "copied_text": "Installation command",
- "action_time": 1681629970000
}
], - "request_id": "string"
}Developer enrichment
This API endpoint enriches the provided GitHub ID or email address by returning comprehensive information about the individual, including personal and company details. Each successful enrichment request consumes 1 API credit.
In some cases, the enrichment process may take longer to complete. When this occurs, the API returns a 202 Accepted response, indicating that the request is still being processed. Once the enrichment is complete, the results will be delivered to a pre-configured callback URL. The callback URL can be set or updated using the Config API.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Request Body schema: application/jsonrequired
Request Body
| handle required | string Provide the GitHub id ("xyzzy" not "https://github.com/xyz") or email ID |
| handle_type required | string Enum: "GITHUB" "EMAIL" |
Responses
Request samples
- Payload
{- "handle": "string",
- "handle_type": "GITHUB"
}Response samples
- 200
- 202
- 400
- 401
- 402
- 422
- 429
- 500
{- "company": {
- "annual_revenue_printed": "string",
- "city": "string",
- "company_name": "string",
- "estimated_num_employees": "string",
- "industry": "string",
- "state": "string"
}, - "person": {
- "country": "string",
- "fname": "string",
- "github_id": "string",
- "lname": "string",
- "title": "string",
- "x_username": "string"
}
}Developer email
This API endpoint fetches business email ID for a given LinkedIn ID. Each successful enrichment request consumes 1 API credit.
In some cases, the enrichment process may take longer to complete. When this occurs, the API returns a 202 Accepted response, indicating that the request is still being processed. Once the enrichment is complete, the results will be delivered to a pre-configured callback URL. The callback URL can be set or updated using the Config API.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Request Body schema: application/jsonrequired
Request Body
| linkedin required | string |
Responses
Request samples
- Payload
{- "linkedin": "string"
}Response samples
- 200
- 400
- 401
- 402
- 422
- 429
- 500
{- "emailId": "user@example.com",
}Create Callback
This API endpoint will set the callback url where the enriched data will be posted.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Request Body schema: application/jsonrequired
Request Body
| api_key required | string |
| webhook_url required | string <uri> |
Responses
Request samples
- Payload
{- "api_key": "string",
}Response samples
- 200
- 400
- 401
- 402
- 422
- 429
- 500
{- "api_key": "string",
}Delete Callback
This API endpoint will delete the current callback URL for a tenant.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
Responses
Response samples
- 400
- 401
- 402
- 422
- 429
- 500
{- "error": {
- "message": "Bad request.",
- "type": "params_invalid"
}
}Create a list
This API endpoint creates a new list for adding accounts or developers. You will get a list ID in the response which you can use to add accounts or developers to the list based of the type of the list you created.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
| user | string Example: user@user.com Username of the person creating the List |
Request Body schema: application/jsonrequired
Request Body
| name required | string Name of the list.(unique) |
| description | string Description of the list |
| type required | string Enum: "ACCOUNT" "DEVELOPER" |
| primaryKey required | string Column name which contains domain for ACCOUNT type list and email, github or linkedin id for DEVELOPER type list. |
required | Array of objects |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "type": "ACCOUNT",
- "primaryKey": "string",
- "mapping": [
- {
- "clientKey": "First Name",
- "fieldType": "String"
}
]
}Response samples
- 200
- 400
- 401
- 402
- 422
- 429
- 500
{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "ACCOUNT"
}Get all lists
This API endpoint fetches all the lists created by the user.
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
| user | string Example: user@user.com Username of the person creating the List |
Responses
Response samples
- 200
- 400
- 401
- 402
- 422
- 429
- 500
[- {
- "id": "string",
- "name": "string",
- "description": "string",
- "type": "ACCOUNT"
}
]Add accounts or developers
This API endpoint adds accounts or developers to the list. You need to pass the list ID in the URL and the data in the request body. Max data to be inserted by a user in a list in 1 call is 1000 rows .
path Parameters
| id required | string Example: 47e9bfb4-2f39-4131-b44c-fb3ef9fd54da Unique ID of the list |
header Parameters
| x-api-key | string Example: aa2e25wd1rrg6fa828fdc32ftahb3461e99f22ec Unique API token |
| user | string Example: user@user.com Username of the person creating the List |
Request Body schema: application/jsonrequired
Request Body
required | Array of objects |
| type | string Enum: "ACCOUNT" "DEVELOPER" |
Responses
Request samples
- Payload
{- "entities": [
- {
- "primaryKey": "github.com/xyz",
- "clientKey": "string",
- "fieldType": "String",
- "companyData": {
- "Name of Column 1": "Value of Column 1",
- "Name of Column 2": "Value of Column 2",
- "Name of other columns": "Values of other Columns"
}
}
], - "type": "ACCOUNT"
}Response samples
- 400
- 401
- 402
- 422
- 429
- 500
{- "error": {
- "message": "Bad request.",
- "type": "params_invalid"
}
}