Get membership status
curl --request POST \
--url https://api.ignitehealth.com/v1/get-membership-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_system": "<string>",
"external_ids": [
{
"type": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.ignitehealth.com/v1/get-membership-status"
payload = {
"external_system": "<string>",
"external_ids": [
{
"type": "<string>",
"value": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_system: '<string>',
external_ids: [{type: '<string>', value: '<string>'}]
})
};
fetch('https://api.ignitehealth.com/v1/get-membership-status', 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://api.ignitehealth.com/v1/get-membership-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_system' => '<string>',
'external_ids' => [
[
'type' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ignitehealth.com/v1/get-membership-status"
payload := strings.NewReader("{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ignitehealth.com/v1/get-membership-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ignitehealth.com/v1/get-membership-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"enrolled": true,
"registered": false,
"opted_out": false
}{
"error": "invalid_request"
}{
"error": "invalid_api_key"
}{
"error": "forbidden"
}{
"error": "ambiguous_identifier"
}{
"error": "payload_too_large"
}{
"error": "rate_limited"
}{
"error": "internal_error"
}Get membership status
For looking up Ignite app access by external identifiers.
POST
/
v1
/
get-membership-status
Get membership status
curl --request POST \
--url https://api.ignitehealth.com/v1/get-membership-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_system": "<string>",
"external_ids": [
{
"type": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.ignitehealth.com/v1/get-membership-status"
payload = {
"external_system": "<string>",
"external_ids": [
{
"type": "<string>",
"value": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_system: '<string>',
external_ids: [{type: '<string>', value: '<string>'}]
})
};
fetch('https://api.ignitehealth.com/v1/get-membership-status', 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://api.ignitehealth.com/v1/get-membership-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_system' => '<string>',
'external_ids' => [
[
'type' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ignitehealth.com/v1/get-membership-status"
payload := strings.NewReader("{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ignitehealth.com/v1/get-membership-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ignitehealth.com/v1/get-membership-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_system\": \"<string>\",\n \"external_ids\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"enrolled": true,
"registered": false,
"opted_out": false
}{
"error": "invalid_request"
}{
"error": "invalid_api_key"
}{
"error": "forbidden"
}{
"error": "ambiguous_identifier"
}{
"error": "payload_too_large"
}{
"error": "rate_limited"
}{
"error": "internal_error"
}Send the exact supported
external_system name and an external_ids array of {type, value} identifiers. Include each required type once, in any order, with a nonblank value. System and type names are case-sensitive.
The response contains exactly three booleans. enrolled is true when the matched employee has a linked company membership or a pending, unexpired linked invitation. registered is true when that employee has a linked app account. opted_out is true when that employee has an effective opt-out in their company’s active plan program.
If no matching employee is found in an authorized company, the response returns false for enrolled, registered, and opted_out. Multiple matching employees return 409 ambiguous_identifier, even when they share a Person ID. Unsupported names, missing or duplicate identifiers, malformed values, and extra properties return 400 invalid_request. A body over 16 KiB returns 413 payload_too_large. Service failures return 500 internal_error rather than false booleans.Authorizations
Body
application/json
Response
App access result.