List family members
curl --request GET \
--url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members \
--header 'Authorization: Bearer <token>'import requests
url = "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8",
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
]{
"message": "invalid_token"
}{
"message": "Company does not belong to the specified partner"
}{
"message": "Company or employee not found"
}{
"message": "Internal server error"
}Family Members
[DRAFT] List family members
GET
/
companies
/
{companyId}
/
employees
/
{employeeId}
/
family-members
List family members
curl --request GET \
--url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members \
--header 'Authorization: Bearer <token>'import requests
url = "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/family-members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8",
"name": "Emma",
"surname": "Smith",
"type": "child",
"gender": "female",
"birthDate": "2018-04-12",
"nationality": "ES",
"legalId": "12345678Z",
"incapacityLevel": "33%"
}
]{
"message": "invalid_token"
}{
"message": "Company does not belong to the specified partner"
}{
"message": "Company or employee not found"
}{
"message": "Internal server error"
}Overview
Returns all family members associated with a specific employee as a direct array.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the company
The unique identifier of the employee
Response
Family members successfully retrieved
The unique identifier of the family member
The family member's first name
The family member's surname
The type of family member
Available options:
child The family member's gender
Available options:
male, female The family member's date of birth in ISO 8601 format (YYYY-MM-DD)
The family member's nationality as an ISO 3166-1 alpha-2 country code in uppercase
Pattern:
^[A-Z]{2}$Example:
"ES"
The family member's incapacity level
Available options:
0%, 33%, 66% The family member's legal identifier