[{"data":1,"prerenderedAt":734},["ShallowReactive",2],{"developers:\u002Fdevelopers\u002Freference-account":3},{"doc":4,"lang":123,"nav":135,"alternatePath":239,"policy":240,"specVersion":284,"reference":285,"layout":130,"toc":716,"prev":726,"next":727,"operations":728,"overview":125,"heroExample":125},{"id":5,"title":6,"apiTag":7,"body":8,"description":120,"draft":121,"extension":122,"lang":123,"meta":124,"navTitle":125,"navigation":126,"order":127,"path":128,"rawbody":129,"section":130,"seo":131,"stem":132,"translationKey":133,"version":125,"__hash__":134},"developers_en\u002Fdevelopers\u002Freference-account.md","Account, teams and members","account",{"type":9,"value":10,"toc":114},"minimark",[11,16,20,69,95,102],[12,13,15],"h2",{"id":14},"overview","Overview",[17,18,19],"p",{},"Start here to find out what your key can read.",[21,22,23,35,51,60],"ul",{},[24,25,26,34],"li",{},[27,28,30],"a",{"href":29},"\u002Fdevelopers\u002Freference-account#me.get",[31,32,33],"code",{},"GET \u002Fv1\u002Fme"," names the integration behind your key, the last four characters of the key, the teams it reads and its scopes. Call it first to check that a key works.",[24,36,37,43,44,50],{},[27,38,40],{"href":39},"\u002Fdevelopers\u002Freference-account#teams.list",[31,41,42],{},"GET \u002Fv1\u002Fteams"," lists every team the key reads, with its name, time zone and default country, in one response. It includes teams that are restricted for now. ",[27,45,47],{"href":46},"\u002Fdevelopers\u002Freference-account#teams.get",[31,48,49],{},"GET \u002Fv1\u002Fteams\u002F{id}"," returns one of them.",[24,52,53,59],{},[27,54,56],{"href":55},"\u002Fdevelopers\u002Freference-account#members.list",[31,57,58],{},"GET \u002Fv1\u002Fmembers"," lists a team's members, by display name only, in one response. Totem exports no email address, phone number or role for a member.",[24,61,62,68],{},[27,63,65],{"href":64},"\u002Fdevelopers\u002Freference-account#health",[31,66,67],{},"GET \u002Fv1\u002Fhealth"," tells you whether the API is up. It is the only endpoint that needs no key.",[17,70,71,72,76,77,79,80,82,83,86,87,89,90,94],{},"A ",[73,74,75],"strong",{},"team"," is a workspace in Totem, with its own boards, members, leads and bookings. A key reads one team or several teams of the same organization. ",[31,78,33],{}," and ",[31,81,42],{}," describe the key and never take the ",[31,84,85],{},"Totem-Team"," header; ",[31,88,58],{}," reads one team, so a key with several teams names it in that header. ",[27,91,93],{"href":92},"\u002Fdevelopers\u002Fauthentication#teams-and-the-totem-team-header","Authentication"," explains when to send it.",[17,96,97,98,101],{},"Every timestamp the API returns is in UTC. Use a team's ",[31,99,100],{},"timezone"," to show its times in local time, never to store them.",[17,103,104,105,108,109,113],{},"A member's id belongs to one team: the same person has a different ",[31,106,107],{},"mem_"," id in each team. Members are not in the changes feed, so read the list when you start syncing a team, when a record names a member you do not know, and at least once a day. A member who leaves the team drops out of the list, while older records keep naming its id: do not re-read the list for an id it did not resolve last time, and if you show names for older records, keep the name from an earlier read. Disabled members stay listed, with nothing that marks them as disabled. Read ",[27,110,111],{"href":39},[31,112,42],{}," on every sync run, since a team that is no longer listed has left the key.",{"title":115,"searchDepth":116,"depth":116,"links":117},"",3,[118],{"id":14,"depth":119,"text":15},2,"Check that a key works and what it can read, list its teams with their time zones, list each team's members, and check that the API is up.",false,"md","en",{},null,true,"40","\u002Fdevelopers\u002Freference-account","---\ntitle: Account, teams and members\ndescription: Check that a key works and what it can read, list its teams with their time zones, list each team's members, and check that the API is up.\nsection: reference\norder: 40\ntranslationKey: reference-account\nlang: en\ndraft: false\napiTag: account\n---\n\n## Overview\n\nStart here to find out what your key can read.\n\n- [`GET \u002Fv1\u002Fme`](\u002Fdevelopers\u002Freference-account#me.get) names the integration behind your key, the last four characters of the key, the teams it reads and its scopes. Call it first to check that a key works.\n- [`GET \u002Fv1\u002Fteams`](\u002Fdevelopers\u002Freference-account#teams.list) lists every team the key reads, with its name, time zone and default country, in one response. It includes teams that are restricted for now. [`GET \u002Fv1\u002Fteams\u002F{id}`](\u002Fdevelopers\u002Freference-account#teams.get) returns one of them.\n- [`GET \u002Fv1\u002Fmembers`](\u002Fdevelopers\u002Freference-account#members.list) lists a team's members, by display name only, in one response. Totem exports no email address, phone number or role for a member.\n- [`GET \u002Fv1\u002Fhealth`](\u002Fdevelopers\u002Freference-account#health) tells you whether the API is up. It is the only endpoint that needs no key.\n\nA **team** is a workspace in Totem, with its own boards, members, leads and bookings. A key reads one team or several teams of the same organization. `GET \u002Fv1\u002Fme` and `GET \u002Fv1\u002Fteams` describe the key and never take the `Totem-Team` header; `GET \u002Fv1\u002Fmembers` reads one team, so a key with several teams names it in that header. [Authentication](\u002Fdevelopers\u002Fauthentication#teams-and-the-totem-team-header) explains when to send it.\n\nEvery timestamp the API returns is in UTC. Use a team's `timezone` to show its times in local time, never to store them.\n\nA member's id belongs to one team: the same person has a different `mem_` id in each team. Members are not in the changes feed, so read the list when you start syncing a team, when a record names a member you do not know, and at least once a day. A member who leaves the team drops out of the list, while older records keep naming its id: do not re-read the list for an id it did not resolve last time, and if you show names for older records, keep the name from an earlier read. Disabled members stay listed, with nothing that marks them as disabled. Read [`GET \u002Fv1\u002Fteams`](\u002Fdevelopers\u002Freference-account#teams.list) on every sync run, since a team that is no longer listed has left the key.\n","reference",{"title":6,"description":120},"developers\u002Freference-account","reference-account","VdQ-NFMZyunXsSL5yITUhJ9V064HfvSp1dXz8zqhL7I",[136,149,176,220],{"section":137,"items":138},"start",[139,142,146],{"path":140,"title":15,"description":141},"\u002Fdevelopers","Read the leads, calls, conversations and bookings of your Totem teams from your own systems, and keep a copy in sync.",{"path":143,"title":144,"description":145},"\u002Fdevelopers\u002Fquickstart","Quickstart","Make your first requests to the Totem API in a few minutes. Check your key, find your team, list leads and start a sync.",{"path":147,"title":93,"description":148},"\u002Fdevelopers\u002Fauthentication","Secret keys and where they may live, the Totem-Team header for keys with several teams, IP allowlists, and how to roll or revoke a key.",{"section":150,"items":151},"guides",[152,156,160,164,168,172],{"path":153,"title":154,"description":155},"\u002Fdevelopers\u002Ftypescript","TypeScript SDK","Use the official TypeScript client to read your Totem data, paginate lists and handle API errors from your server.",{"path":157,"title":158,"description":159},"\u002Fdevelopers\u002Fsync","Keep a copy in sync","Copy a team with the changes feed and keep the copy current. Apply pages safely, recover from errors, and start from a reference client that Totem tests.",{"path":161,"title":162,"description":163},"\u002Fdevelopers\u002Fpagination","Lists and pagination","How list endpoints return records a page at a time, how to read every page, and what order and filters a list supports.",{"path":165,"title":166,"description":167},"\u002Fdevelopers\u002Fcoverage","Data coverage","What Totem records, since when, and how to tell an empty value from a fact that was never recorded.",{"path":169,"title":170,"description":171},"\u002Fdevelopers\u002Ftesting","Testing and go-live","How to build and test an integration safely while the API has no test environment, and what to check before you go live.",{"path":173,"title":174,"description":175},"\u002Fdevelopers\u002Fsecurity","Security and personal data","How Totem protects API keys and the data the API serves, what it records about each key, where the API runs, and what to do with the personal data you copy.",{"section":130,"items":177},[178,182,186,190,191,196,201,206,211,216],{"path":179,"title":180,"description":181},"\u002Fdevelopers\u002Fconventions","Conventions","The notation these docs use, and the rules every response follows: ids, timestamps, empty values, amounts, enums, versions, stability, errors and untrusted text.",{"path":183,"title":184,"description":185},"\u002Fdevelopers\u002Ferrors","Errors","The error format, how your integration should handle each kind of error, and every error code with when it happens and what to do.",{"path":187,"title":188,"description":189},"\u002Fdevelopers\u002Frate-limits","Rate limits","How much a key can read per minute and per day, what counts toward each limit, how to retry after a 429, and how long an initial sync takes.",{"path":128,"title":6,"description":120,"apiTag":7},{"path":192,"title":193,"description":194,"apiTag":195},"\u002Fdevelopers\u002Freference-leads","Leads, boards and activities","List, fetch and search a team's leads and clients, read each lead's activities, and list the boards and stages they move through.","leads",{"path":197,"title":198,"description":199,"apiTag":200},"\u002Fdevelopers\u002Freference-calls","Calls","List and fetch a team's calls, with their direction, timing and a normalized outcome. No recordings or transcripts.","calls",{"path":202,"title":203,"description":204,"apiTag":205},"\u002Fdevelopers\u002Freference-conversations","Conversations","List and fetch a team's conversations on every channel, with their status, assignee, whether a person has taken them over and when the last messages came and went. Never message content.","conversations",{"path":207,"title":208,"description":209,"apiTag":210},"\u002Fdevelopers\u002Freference-bookings","Bookings and services","List and fetch a team's bookings, and list the services its customers can book.","bookings",{"path":212,"title":213,"description":214,"apiTag":215},"\u002Fdevelopers\u002Freference-sync","Changes feed","One endpoint that copies a team and then returns every change, page by page.","sync",{"path":217,"title":218,"description":219},"\u002Fdevelopers\u002Fobjects","All objects","Every object the API returns, field by field, with an example of each.",{"section":221,"items":222},"resources",[223,227,231,235],{"path":224,"title":225,"description":226},"\u002Fdevelopers\u002Fchangelog","Changelog","Changes to the Totem API, newest first, each under the date it shipped.",{"path":228,"title":229,"description":230},"\u002Fdevelopers\u002Fsupport","Support","How to get help with the Totem API, what to include in a request, and what to do if a key leaks.",{"path":232,"title":233,"description":234},"\u002Fdevelopers\u002Fglossary","Glossary","The terms these docs use, defined in one place, each with a link to the page that explains it.",{"path":236,"title":237,"description":238},"\u002Fdevelopers\u002Ffaq","FAQ","Short answers to the questions developers ask most about the Totem API, with links to the details.","\u002Fdevelopers\u002Fes\u002Freference-account",{"ACTIVATION_MARGIN_MS":241,"ADMIN_ACCESS_DISCLOSURE_VERSION":242,"AUDIT_RETENTION_DAYS":243,"AUTH_FAILURE_LIMITS":244,"CAPTURE_LAG_FLOOR_MS":248,"CAPTURE_LAG_P99_MS":125,"CURSOR_MAX_AGE_DAYS":249,"DIRTY_TTL_DAYS":249,"FAMILY_TEAM_SCOPE":250,"FAMILY_TEAM_SCOPE_OPTIONS":251,"FEED_SETTLE_LAG_MS":253,"GATE_REFRESH_MS":241,"INTEGRATION_NAME_LENGTH":254,"INTEGRATION_PURPOSE_LENGTH":256,"KEY_CACHE_TTL_MS":259,"KEY_STATS_RETENTION_DAYS":260,"LEAD_RESPONSE_READ_BUDGET":261,"LIST_SCAN_MAX":264,"MAX_FAMILY_INTEGRATION_TEAMS":249,"MAX_INTEGRATIONS_PER_FAMILY":265,"MAX_IP_ALLOWLIST":246,"PAGE_LIMIT":266,"PLATFORM_CONFIG_TTL_MS":269,"REMOVAL_RETENTION_DAYS":270,"REQUEST_BODY_MAX_BYTES":271,"ROLL_GRACE_DEFAULT_HOURS":272,"ROLL_GRACE_HOURS":273,"SEARCH_MAX_RESULTS":265,"SENSITIVE_SECTOR_POLICY":276,"SENSITIVE_SECTOR_POLICY_OPTIONS":277,"SYNC_DAILY_BUDGET":279,"SYNC_VELOCITY":281,"TEAM_CACHE_TTL_MS":283},60000,"2026-10-17",365,{"perIpPerMinute":245,"perLookupIdPerMinute":246,"banMs":247},60,20,600000,300000,30,"explicit_list",[250,252],"all_family_teams",10000,{"min":119,"max":255},80,{"min":257,"max":258},1,280,5000,90,{"conversations":246,"messageReads":262,"calls":263},200,50,1000,10,{"default":267,"max":268},25,100,15000,45,16384,24,[274,257,272,275],0,168,"exclude",[276,278],"allow",{"floor":280,"recordsMultiplier":116},250000,{"perMinute":282,"burst":253},2000,30000,"1.0a",{"operations":286,"schemas":536,"errors":601,"commonErrors":712,"defaultStability":293,"policy":240,"problemExample":713},[287,371,419,465,509],{"id":288,"method":289,"path":290,"summary":291,"description":292,"stability":293,"scopes":294,"rateClass":295,"tenantBinding":296,"authenticated":126,"parameters":297,"parametersByLocation":298,"body":302,"bodyDescription":115,"responseFields":303,"responseComponent":349,"listOf":125,"example":350,"errors":358,"tag":7},"me.get","GET","\u002Fv1\u002Fme","Get the integration behind this key","Returns the integration this key belongs to: its name, the last four characters of the key, the teams it reads today and its scopes. Call it first to check that a key works and to see which teams it reads; `GET \u002Fv1\u002Fteams` has their details.","beta",[],"read","principal",[],{"path":299,"query":300,"header":301},[],[],[],[],[304,311,317,321,324,327,332,339],{"name":305,"type":306,"required":126,"description":307,"nullable":121,"typeLabel":308,"enumValues":309,"constant":126},"object","\"integration\"","Always `integration`.","string",[310],"integration",{"name":312,"type":308,"required":126,"description":313,"nullable":121,"typeLabel":308,"constraints":314},"id","Public id of the integration.",{"prefixes":315},[316],"prn_",{"name":318,"type":319,"required":126,"description":320,"nullable":121,"typeLabel":319},"livemode","boolean","`true` for a real key; `false` in example data.",{"name":322,"type":308,"required":126,"description":323,"nullable":121,"typeLabel":308},"name","The name an administrator gave the integration.",{"name":325,"type":305,"required":126,"description":326,"nullable":121,"typeLabel":305},"key","The key used for this request.",{"name":328,"type":308,"required":126,"description":329,"nullable":121,"typeLabel":308,"constraints":330},"key.last4","The last four characters of the key used for this request.",{"minLength":331,"maxLength":331},4,{"name":333,"type":334,"required":126,"description":335,"nullable":121,"typeLabel":334,"constraints":336},"teams","Array\u003Cstring>","The teams this key reads today. Their details are in `GET \u002Fv1\u002Fteams`.",{"prefixes":337},[338],"team_",{"name":340,"type":341,"required":126,"description":342,"nullable":121,"typeLabel":334,"enumValues":343},"scopes","Array\u003C\"teams:read\" | \"crm:read\" | \"calls:read\" | \"messages:read\" | \"calendar:read\">","The key's scopes: the fixed read set in v1.0a.",[344,345,346,347,348],"teams:read","crm:read","calls:read","messages:read","calendar:read","Me",{"object":310,"id":351,"livemode":121,"name":352,"key":353,"teams":355,"scopes":357},"prn_m1NFIcoIU8smXfqR4ymgt6j07TfRF","Example CRM sync",{"last4":354},"Q7xZ",[356],"team_r9uYrIW4gSFJJ6hZQ9ip1UIpPaAD1CF7NR",[344,345,346,347,348],[359,360,361,362,363,364,365,366,367,368,369,370],"invalid_request","secret_key_in_browser","invalid_credentials","key_expired","insufficient_scope","plan_not_entitled","ip_not_allowed","capability_disabled","rate_limited","internal_error","api_disabled","service_unavailable",{"id":372,"method":289,"path":373,"summary":374,"description":375,"stability":293,"scopes":376,"rateClass":215,"tenantBinding":296,"authenticated":126,"parameters":377,"parametersByLocation":378,"body":382,"bodyDescription":115,"responseFields":383,"responseComponent":410,"listOf":397,"example":411,"errors":417,"tag":7},"teams.list","\u002Fv1\u002Fteams","List the teams this key reads","Lists every team this key reads, in one response that is never paged, including teams that are restricted for now (their other endpoints answer `403`). Re-read it on every sync run: a team that is no longer listed has left the key, so delete its copy and its cursor.",[344],[],{"path":379,"query":380,"header":381},[],[],[],[],[384,389,400,405],{"name":305,"type":385,"required":126,"description":386,"nullable":121,"typeLabel":308,"enumValues":387,"constant":126},"\"list\"","Always `list`.",[388],"list",{"name":390,"type":391,"required":126,"description":392,"nullable":121,"typeLabel":391,"typeTokens":393,"ref":397},"data","Array\u003CTeam>","Every team this key reads, restricted ones included.",[394,396,398],{"text":395},"Array\u003C",{"text":397,"ref":397},"Team",{"text":399},">",{"name":401,"type":402,"required":126,"description":403,"nullable":121,"typeLabel":319,"enumValues":404,"constant":126},"has_more","false","Always `false`: this list is never paged.",[121],{"name":406,"type":407,"required":126,"description":408,"nullable":126,"typeLabel":407,"typeTokens":409},"next_cursor","null","Always `null`: there is no next page.",[],"TeamList",{"object":388,"data":412,"has_more":121,"next_cursor":125},[413],{"id":356,"object":75,"livemode":121,"name":414,"timezone":415,"default_country":416},"Example Dental","America\u002FNew_York","US",[359,360,361,362,363,364,365,366,367,368,369,370,418],"quota_exceeded",{"id":420,"method":289,"path":421,"summary":422,"description":423,"stability":293,"scopes":424,"rateClass":295,"tenantBinding":425,"authenticated":126,"parameters":426,"parametersByLocation":432,"body":436,"bodyDescription":115,"responseFields":437,"responseComponent":397,"listOf":125,"example":460,"errors":461,"tag":7},"teams.get","\u002Fv1\u002Fteams\u002F{id}","Get a team","Returns one team this key reads: its name, time zone and default country. A team the key does not read answers `404 resource_missing`.",[344],"resource_id",[427],{"name":312,"type":308,"required":126,"description":428,"nullable":121,"typeLabel":308,"constraints":429,"location":431},"The team's public id.",{"prefixes":430},[338],"path",{"path":433,"query":434,"header":435},[427],[],[],[],[438,442,446,448,452,455],{"name":312,"type":308,"required":126,"description":439,"nullable":121,"typeLabel":308,"constraints":440},"Public id of the record.",{"prefixes":441},[338],{"name":305,"type":443,"required":126,"description":444,"nullable":121,"typeLabel":308,"enumValues":445,"constant":126},"\"team\"","Always `team`.",[75],{"name":318,"type":319,"required":126,"description":447,"nullable":121,"typeLabel":319},"`true` for real data; `false` in example data.",{"name":322,"type":449,"required":126,"description":450,"nullable":126,"typeLabel":308,"constraints":451},"string | null","The team's name as it appears in Totem, or null when none is stored.",{"minLength":257},{"name":100,"type":308,"required":126,"description":453,"nullable":121,"typeLabel":308,"constraints":454},"The team's IANA time zone: its business-hours zone when that is valid, otherwise its default country's (Europe\u002FMadrid when neither is set). Interpret the team's local times with it.",{"minLength":257},{"name":456,"type":449,"required":126,"description":457,"nullable":126,"typeLabel":308,"constraints":458},"default_country","The team's default country (ISO 3166-1 alpha-2), which Totem uses when someone types a phone number without a prefix; null when none is set. The API does not apply it: `Lead.phone` is validated without a default country, so a number stored without its country prefix reads `phone_status: invalid`.",{"pattern":459},"^[A-Z]{2}$",{"id":356,"object":75,"livemode":121,"name":414,"timezone":415,"default_country":416},[359,360,361,362,363,364,365,366,367,368,369,370,462,463,464],"resource_missing","team_state_restricted","sector_restricted",{"id":466,"method":289,"path":467,"summary":468,"description":469,"stability":293,"scopes":470,"rateClass":215,"tenantBinding":471,"authenticated":126,"parameters":472,"parametersByLocation":478,"body":482,"bodyDescription":115,"responseFields":483,"responseComponent":498,"listOf":492,"example":499,"errors":505,"tag":7},"members.list","\u002Fv1\u002Fmembers","List team members","Lists every member of the team in one response that is never paged and takes no `limit` or `cursor`. Members are not in the changes feed: read this list when you start syncing a team, again when an item names a member you do not know, and at least once a day. A member who leaves the team drops out of the list while older records keep naming its id, so keep a name you need from an earlier read.",[344],"team_header",[473],{"name":85,"type":308,"required":121,"description":474,"nullable":121,"typeLabel":308,"constraints":475,"conditional":126,"location":477},"The team to read, as a `team_…` id. Omit it when the key reads one team; it is required when the key reads several (`400 team_required`). When you send it, it must name a team the key reads: a malformed id gets `400 invalid_request`, and a team outside the key gets `404 team_not_accessible`, as does a request without it once the key reads no team at all.",{"prefixes":476},[338],"header",{"path":479,"query":480,"header":481},[],[],[473],[],[484,486,494,496],{"name":305,"type":385,"required":126,"description":386,"nullable":121,"typeLabel":308,"enumValues":485,"constant":126},[388],{"name":390,"type":487,"required":126,"description":488,"nullable":121,"typeLabel":487,"typeTokens":489,"ref":492},"Array\u003CMember>","Every member of the team.",[490,491,493],{"text":395},{"text":492,"ref":492},"Member",{"text":399},{"name":401,"type":402,"required":126,"description":403,"nullable":121,"typeLabel":319,"enumValues":495,"constant":126},[121],{"name":406,"type":407,"required":126,"description":408,"nullable":126,"typeLabel":407,"typeTokens":497},[],"MemberList",{"object":388,"data":500,"has_more":121,"next_cursor":125},[501],{"id":502,"object":503,"livemode":121,"team":356,"display_name":504},"mem_h548E7UiYhutHhucVrQCzkM0eaea0","member","Sam Lee",[359,360,361,362,363,364,365,366,367,368,369,370,506,507,463,464,508,418],"team_required","team_not_accessible","capture_not_ready",{"id":510,"method":289,"path":511,"summary":512,"description":513,"stability":293,"scopes":514,"rateClass":515,"tenantBinding":515,"authenticated":121,"parameters":516,"parametersByLocation":517,"body":521,"bodyDescription":115,"responseFields":522,"responseComponent":533,"listOf":125,"example":534,"errors":535,"tag":7},"health","\u002Fv1\u002Fhealth","Check that the API is up","Tells you whether the API is up; call it with `GET`, because the firewall in front of the API answers any other method, `HEAD` included, with a plain `404`. It needs no key and takes no query string: any parameter, even a cache-buster, answers `400 invalid_request`. The `Totem-Release` response header names the release that answered.",[],"none",[],{"path":518,"query":519,"header":520},[],[],[],[],[523,527],{"name":305,"type":524,"required":126,"description":525,"nullable":121,"typeLabel":308,"enumValues":526,"constant":126},"\"health\"","Always `health`.",[510],{"name":528,"type":529,"required":126,"description":530,"nullable":121,"typeLabel":308,"enumValues":531,"constant":126},"status","\"ok\"","Always `ok`: when the API is not available, the answer is an error instead.",[532],"ok","Health",{"object":510,"status":532},[359,360,368,370],[537,561,579],{"name":349,"description":538,"fields":539,"example":555,"variants":559,"sharedFields":560},"The integration that owns the key, with the teams the key reads.",[540,542,545,546,547,548,550,553],{"name":305,"type":306,"required":126,"description":307,"nullable":121,"typeLabel":308,"enumValues":541,"constant":126},[310],{"name":312,"type":308,"required":126,"description":313,"nullable":121,"typeLabel":308,"constraints":543},{"prefixes":544},[316],{"name":318,"type":319,"required":126,"description":320,"nullable":121,"typeLabel":319},{"name":322,"type":308,"required":126,"description":323,"nullable":121,"typeLabel":308},{"name":325,"type":305,"required":126,"description":326,"nullable":121,"typeLabel":305},{"name":328,"type":308,"required":126,"description":329,"nullable":121,"typeLabel":308,"constraints":549},{"minLength":331,"maxLength":331},{"name":333,"type":334,"required":126,"description":335,"nullable":121,"typeLabel":334,"constraints":551},{"prefixes":552},[338],{"name":340,"type":341,"required":126,"description":342,"nullable":121,"typeLabel":334,"enumValues":554},[344,345,346,347,348],{"object":310,"id":351,"livemode":121,"name":352,"key":556,"teams":557,"scopes":558},{"last4":354},[356],[344,345,346,347,348],[],[],{"name":397,"description":562,"fields":563,"example":576,"variants":577,"sharedFields":578},"A team this key reads, with its time zone and default country.",[564,567,569,570,572,574],{"name":312,"type":308,"required":126,"description":439,"nullable":121,"typeLabel":308,"constraints":565},{"prefixes":566},[338],{"name":305,"type":443,"required":126,"description":444,"nullable":121,"typeLabel":308,"enumValues":568,"constant":126},[75],{"name":318,"type":319,"required":126,"description":447,"nullable":121,"typeLabel":319},{"name":322,"type":449,"required":126,"description":450,"nullable":126,"typeLabel":308,"constraints":571},{"minLength":257},{"name":100,"type":308,"required":126,"description":453,"nullable":121,"typeLabel":308,"constraints":573},{"minLength":257},{"name":456,"type":449,"required":126,"description":457,"nullable":126,"typeLabel":308,"constraints":575},{"pattern":459},{"id":356,"object":75,"livemode":121,"name":414,"timezone":415,"default_country":416},[],[],{"name":492,"description":580,"fields":581,"example":598,"variants":599,"sharedFields":600},"A team member, by display name only: Totem exports no email, phone or role.",[582,585,589,590,594],{"name":312,"type":308,"required":126,"description":439,"nullable":121,"typeLabel":308,"constraints":583},{"prefixes":584},[107],{"name":305,"type":586,"required":126,"description":587,"nullable":121,"typeLabel":308,"enumValues":588,"constant":126},"\"member\"","Always `member`.",[503],{"name":318,"type":319,"required":126,"description":447,"nullable":121,"typeLabel":319},{"name":75,"type":308,"required":126,"description":591,"nullable":121,"typeLabel":308,"constraints":592},"The team this record belongs to.",{"prefixes":593},[338],{"name":595,"type":449,"required":126,"description":596,"nullable":126,"typeLabel":308,"constraints":597},"display_name","The member's display name, or first and last name, or null when none is stored. Totem exports no email, phone or role.",{"minLength":257},{"id":502,"object":503,"livemode":121,"team":356,"display_name":504},[],[],[602,609,613,617,623,627,633,639,643,647,652,656,661,667,674,680,686,693,697,703,708],{"code":359,"status":603,"title":604,"wireTitle":604,"action":605,"description":606,"fix":607,"retryable":121,"retry":608},400,"Invalid request","fix_request","Something in the request is not valid: an unknown, repeated or out-of-range query parameter, a query string or body on an endpoint that takes none, a cursor issued for another endpoint, filter or team, a malformed `Totem-Team` header, or a body that is not the JSON this endpoint expects. `param` names the parameter, header or field at fault. A conversations cursor is also refused once the conversation it points at has been erased.","Correct what `param` names before you retry: the same request fails the same way. For a cursor, send the `next_cursor` you received from the same endpoint, with the same filters and team. If a conversations cursor you did not change is refused, start that list again from the first page.","no",{"code":506,"status":603,"title":610,"wireTitle":610,"action":605,"description":611,"fix":612,"retryable":121,"retry":608},"Team required","The key reads more than one team and this endpoint reads one team's data, but the request does not say which team.","Send the team's id (`team_…`, as listed by `GET \u002Fv1\u002Fteams`) in the `Totem-Team` header.",{"code":360,"status":603,"title":614,"wireTitle":614,"action":605,"description":615,"fix":616,"retryable":121,"retry":608},"Secret key sent from a browser","The request carried a secret key together with an `Origin` header, which means it came from a browser. Totem refuses it before reading anything.","Call the API only from your server. If the key has been in a web page, a mobile app or a browser extension, treat it as leaked: roll it and mark it as compromised, so the old key stops working at once.",{"code":361,"status":618,"title":619,"wireTitle":619,"action":620,"description":621,"fix":622,"retryable":121,"retry":608},401,"Invalid credentials","check_credentials","The `Authorization` header is missing or malformed, or the key is unknown, wrong or revoked, or its integration is no longer active.","Send `Authorization: Bearer \u003Ckey>` with a current secret key. Do not retry in a loop: repeated failures from one IP address, or against one key, lock it out for a while with `429 rate_limited`.",{"code":362,"status":618,"title":624,"wireTitle":624,"action":620,"description":625,"fix":626,"retryable":121,"retry":608},"Key expired","The key was rolled and its grace period is over.","Deploy the key that replaced it: the old key is past its grace period and will not work again. If there is no replacement, create a new key in Settings → Developers.",{"code":363,"status":628,"title":629,"wireTitle":629,"action":630,"description":631,"fix":632,"retryable":121,"retry":608},403,"Insufficient scope","contact_support","The key lacks a permission this endpoint needs. Every v1.0a key holds the full read set, so this should not happen.","Contact support and quote the `Totem-Request-Id` of the response.",{"code":364,"status":628,"title":634,"wireTitle":634,"action":635,"description":636,"fix":637,"retryable":126,"retry":638},"Plan not entitled","keep_and_retry","The organization's plan does not include the Totem API at the moment.","Keep your data and cursors, and pause calls until the customer has a plan with API access again; then continue where you left off. While access is refused, the feed delivers nothing for the key's teams, removals included: if the refusal lasts longer than your retention policy allows, delete your copy.","restored",{"code":365,"status":628,"title":640,"wireTitle":640,"action":620,"description":641,"fix":642,"retryable":121,"retry":608},"IP address not allowed","The key is valid, but the request came from an IP address outside the integration's allowlist.","Call from an allowed address, or ask an administrator to add yours to the allowlist in Settings → Developers.",{"code":463,"status":628,"title":644,"wireTitle":644,"action":635,"description":645,"fix":646,"retryable":126,"retry":638},"Team restricted","The team is restricted for now: it is disabled (for example, suspended for non-payment), archived or billing-only, or its API access is paused. `GET \u002Fv1\u002Fteams` still lists it.","Keep the team's data and cursor, skip it for this run and try again later. The key's other teams are not affected. While the team is restricted, the feed delivers nothing for it, removals included: if the restriction lasts longer than your retention policy allows, delete the team's copy.",{"code":464,"status":628,"title":648,"wireTitle":648,"action":635,"description":649,"fix":650,"retryable":121,"retry":651},"Sector restricted","Totem does not export this team's data through the API because the team works in a sensitive sector, such as health care, where its records can reveal health information.","Skip the team: waiting does not change this. The feed delivers nothing for it, removals included, so keep what you already have only as long as your retention policy allows, then delete the team's copy. Talk to the customer or to Totem if you need its data.","blocked",{"code":366,"status":628,"title":653,"wireTitle":653,"action":635,"description":654,"fix":655,"retryable":126,"retry":638},"Capability disabled","Totem has temporarily switched this endpoint off for every key.","Keep your data and cursors and try again later; the other endpoints keep working.",{"code":462,"status":657,"title":658,"wireTitle":658,"action":605,"description":659,"fix":660,"retryable":121,"retry":608},404,"Resource not found","The record does not exist, was removed, belongs to a team this key does not read, or was created so recently that Totem has not prepared it yet. A `GET` or `POST` under `\u002Fv1\u002F` that matches no endpoint also gets this code. Any other method, and any path outside `\u002Fv1\u002F`, gets a plain `404` from the firewall in front of the API, with no problem body and no `Totem-Request-Id`.","Check the id and the path. If the record was created moments ago, do not retry in a loop: the changes feed delivers it as soon as it is ready.",{"code":507,"status":657,"title":662,"wireTitle":662,"action":663,"description":664,"fix":665,"retryable":121,"retry":666},"Team not accessible","drop_team","The `Totem-Team` header names a team this key does not read: one it never covered, one removed from the key or from the organization, or one that was deleted. Without the header, it means the key no longer reads any team.","Re-read `GET \u002Fv1\u002Fteams` before you act. If the team is no longer listed, delete its copy and its cursor; if it is still listed, keep everything and try again on the next run.","confirm",{"code":668,"status":669,"title":670,"wireTitle":670,"action":671,"description":672,"fix":673,"retryable":121,"retry":608},"resync_required",409,"Resync required","resync","Totem cannot continue the feed from this cursor: the data was restored from a backup, or a gap was found in the team's changes.","Run a full resync: forget the versions you stored for the team, read the feed again without a cursor, and once it has caught up delete every local record of the team it did not deliver. Keep using your current copy until then.",{"code":508,"status":669,"title":675,"wireTitle":675,"action":676,"description":677,"fix":678,"retryable":126,"retry":679},"Team data is still being prepared","wait_capture","Totem is still preparing this team's data for the API. This happens once per team, after it is first added to any key; adding it to another key later does not repeat it.","Keep whatever you hold for the team and try again in a few minutes; the key's other teams keep syncing meanwhile.","later",{"code":681,"status":682,"title":683,"wireTitle":683,"action":671,"description":684,"fix":685,"retryable":121,"retry":608},"sync_cursor_expired",410,"Sync cursor expired","The cursor is more than 30 days old, counted from the point in the feed it reached (or, while an initial sync is still running, from when that sync started).","Run a full resync, as for `resync_required`. To prevent it, save the `next_cursor` of every page, empty pages included: the cursor of a team you poll regularly never ages out.",{"code":367,"status":687,"title":688,"wireTitle":688,"action":689,"description":690,"fix":691,"retryable":126,"retry":692},429,"Rate limited","retry_after","The key went over its rate limit (items per minute), or too many failed authentication attempts from this IP address or against this key have locked it out for a while.","Wait the seconds in `Retry-After`, then retry the same request. Each request sets aside its full `limit` up front and gives back what it does not use, so a smaller `limit` keeps a nearly spent allowance moving.","after",{"code":418,"status":687,"title":694,"wireTitle":694,"action":689,"description":695,"fix":696,"retryable":126,"retry":692},"Daily quota exceeded","The key has spent its daily quota of items. Every item returned by the changes feed and by every list counts toward it, including `GET \u002Fv1\u002Fteams`, `GET \u002Fv1\u002Fmembers`, `GET \u002Fv1\u002Fbooking_services` and a lead's activities. The quota resets at 00:00 UTC.","Stop syncing until 00:00 UTC (`Retry-After` counts the seconds) and resume then with the same cursor: nothing is lost. Requests for one record, such as `GET \u002Fv1\u002Fleads\u002F{id}`, search and `GET \u002Fv1\u002Fme` do not count toward the quota and keep working.",{"code":368,"status":698,"title":699,"wireTitle":699,"action":700,"description":701,"fix":702,"retryable":126,"retry":700},500,"Internal error","backoff","Something went wrong inside Totem while answering this request.","Retry with exponential backoff. If it keeps failing, contact support and quote the `Totem-Request-Id`.",{"code":369,"status":704,"title":705,"wireTitle":705,"action":700,"description":706,"fix":707,"retryable":126,"retry":700},503,"API disabled","Totem has temporarily switched the API off for every key.","Keep your data and cursors and retry later with exponential backoff.",{"code":370,"status":704,"title":709,"wireTitle":709,"action":700,"description":710,"fix":711,"retryable":126,"retry":700},"Service unavailable","Reserved: the API itself does not return this code today. A `503` from the load balancer or the hosting platform in front of the API arrives without a problem body; treat it like this code.","Retry with exponential backoff; your data and cursors stay valid.",[359,360,361,362,363,364,365,366,367,368,369,370],{"type":714,"title":658,"status":657,"code":462,"request_id":715,"doc_url":714},"https:\u002F\u002Ftotemstudio.ai\u002Fdevelopers\u002Ferrors#resource_missing","req_0f6b2c1e-8d4a-4b7e-9c3f-5a2d1e7b9c40",[717,718,719,720,721,722,723,724,725],{"id":14,"text":15,"depth":119},{"id":288,"text":291,"depth":119},{"id":372,"text":374,"depth":119},{"id":420,"text":422,"depth":119},{"id":466,"text":468,"depth":119},{"id":510,"text":512,"depth":119},{"id":349,"text":349,"depth":119},{"id":397,"text":397,"depth":119},{"id":492,"text":492,"depth":119},{"path":187,"title":188,"section":130},{"path":192,"title":193,"section":130},[729,730,731,732,733],{"id":288,"method":289,"path":290,"summary":291},{"id":372,"method":289,"path":373,"summary":374},{"id":420,"method":289,"path":421,"summary":422},{"id":466,"method":289,"path":467,"summary":468},{"id":510,"method":289,"path":511,"summary":512},1792502789510]