{"id":31933,"date":"2023-01-23T10:33:21","date_gmt":"2023-01-23T15:33:21","guid":{"rendered":"https:\/\/team.centrix.one\/?post_type=docs&#038;p=31933"},"modified":"2024-06-17T17:31:29","modified_gmt":"2024-06-17T21:31:29","password":"","slug":"centrixone-api","status":"publish","type":"docs","link":"https:\/\/www.centrix.one\/en\/faq\/system\/centrixone-api\/","title":{"rendered":"Guide: CentrixOne API"},"content":{"rendered":"\n<div class=\"wp-block-group faq-frame faq\"><div class=\"wp-block-group__inner-container is-layout-flow wp-block-group-is-layout-flow\">\n<h2 class=\"wp-block-heading has-medium-font-size\" id=\"h-introduction\"><strong>Introduction<\/strong><\/h2>\n\n\n\n<p>Here is how the CentrixOne CRM API works:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Read = GET<\/li>\n\n\n\n<li>Add\/edit = POST<\/li>\n\n\n\n<li>Everything happens in a table from zero to several contacts. (In reading as in addition \/ modification)<\/li>\n\n\n\n<li>The result &#8220;success&#8221; is always in JSON (Content Type: application \/ json) with &#8220;Result&#8221; at the value &#8220;Success&#8221;.<\/li>\n\n\n\n<li>In case of error, just read the text content returned with the codes 4XX and 5XX.<\/li>\n\n\n\n<li>It is possible to receive a &#8220;503 Service Unavailable&#8221; code with a &#8220;Retry-After&#8221; header when the service is not available. For the moment, I advise to try again later with any errors 4XX, 5XX or the 200 which are not in &#8220;application \/ json&#8221;. This part remains to be improved.<\/li>\n\n\n\n<li>There is a html read cache system and that&#8217;s why all the parameters are in the URL. You will receive a &#8220;Last-Modified&#8221; header for reading. If you redo the same query with the header &#8220;If-Modified-Since&#8221;, you will receive a code &#8220;304 Not Modified&#8221; if nothing in the result has been modified. Convenient for mobile applications and software that request the same query at regular intervals.<\/li>\n<\/ul>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-group faq-frame faq\"><div class=\"wp-block-group__inner-container is-layout-flow wp-block-group-is-layout-flow\">\n<h2 class=\"wp-block-heading has-medium-font-size\" id=\"h-how-can-i-obtain-my-api-key-and-centrixone-account-number\"><strong>How can I obtain my API key and CentrixOne account number?<\/strong><\/h2>\n\n\n\n<p>As this information is confidential, you need to send a request by email to support@centrix.one. Our team will validate your identity and the use you will make of this information, then an API key will be generated by our dev team.<\/p>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-group faq-frame faq\"><div class=\"wp-block-group__inner-container is-layout-flow wp-block-group-is-layout-flow\">\n<h2 class=\"wp-block-heading has-medium-font-size\" id=\"h-read-contacts\"><strong>Read contacts<\/strong><\/h2>\n\n\n\n<p>Here are some examples of basic filters:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>C9999 to return the contact with the Centrix identifier 9999<\/li>\n\n\n\n<li>E9999 to return the contact with External ID 9999 (your login)<\/li>\n\n\n\n<li>S999 to return the contacts from the list 999<\/li>\n\n\n\n<li>All these parameters can be specified at the same time, they will be joined in &#8220;AND&#8221;. Examples;\n<ul class=\"wp-block-list\">\n<li>&#8220;C1234, C125&#8221; will return contacts 1234 and 125 as well as contact information to all lists. (A contact can be in one or more lists.)<\/li>\n\n\n\n<li>&#8220;C1234, S999&#8221; will return contact 1234 if it belongs to the list S999 and only the contact information for the list 999<\/li>\n\n\n\n<li>&#8220;S999&#8221; will return all contacts and contact information for this list. (A list is internally called &#8220;Script&#8221; in Centrix, which goes back to the time of call scripts in call center.)<\/li>\n\n\n\n<li>&#8220;E9999&#8221; will return contact with externalID (your username) 9999 as well as contact information to all lists.<\/li>\n\n\n\n<li>Etc.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>The extension of the page is &#8220;.awp&#8221;.<\/p>\n\n\n\n<p>Here are the optional parameters:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>fields : List of requested fields separated by comma. Value &#8220;all&#8221; return all fields. (Make a query with &#8220;all&#8221; to see the list of available fields.)\n<ul class=\"wp-block-list\">\n<li>Exception; the fields in &#8220;ContactScript&#8221; must be preceded by &#8220;cs_&#8221; in the list of requested fields. Ex .: cs_salesrep1<\/li>\n\n\n\n<li>Abbreviation; CC_ = Contact_Cusom_, AC_ = Account_Custom_, CCS_ = Contact_Custom_Script_, ACS_ = Account_Custom_Script_<\/li>\n\n\n\n<li>Multiple choices in custom fields have &#8220;::&#8221; as separator.<\/li>\n\n\n\n<li>filters : Allows you to specify advanced filters. The elements are separated by TAB (% 09 in the URL) and the conditions are separated by LF (% 0A in the URL)\n<ul class=\"wp-block-list\">\n<li>Structure;\n<ul class=\"wp-block-list\">\n<li>Separator prefix : &#8220;(&#8220;, &#8220;((&#8220;, &#8220;AND&#8221;, &#8220;OR&#8221;,&#8221;AND(&#8220;,&#8221;OR(&#8220;, etc.<\/li>\n\n\n\n<li>Nome of fields : &#8220;company&#8221;, etc.<\/li>\n\n\n\n<li>Operator : &#8220;=&#8221;, &#8220;&lt;&gt;&#8221;, &#8220;&lt;&#8220;, &#8220;&gt;&#8221;,&#8221;&lt;=&#8221;, &#8220;&gt;=&#8221;,&#8221;[=&#8221;,&#8221;=]&#8221;, &#8220;[=]&#8221;<\/li>\n\n\n\n<li>Value : &#8220;Test&#8221;, etc. (Insensible Maj\/Min)<\/li>\n\n\n\n<li>Separator suffix : &#8220;)&#8221;,&#8221;))&#8221;,etc.<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>It is possible to specify a basic filter at the same time (which will be attached in &#8220;AND&#8221;) or to specify &#8220;all&#8221; as the basic filter to disable the basic filter.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>The result is a JSON with an array of Contacts that in each contact will have a ContactScript table. (The lists)<\/p>\n\n\n\n<p>Here are some examples:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Contacts-Account-APIKey.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Contacts-Account-APIKey-C999999.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Contacts-Account-APIKey-all.awp?fields=all&amp;filters=%09company%09%5B=%09test%09%0AOR%09company%09%5B=%09centrix%09<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Contacts-Account-APIKey-S9999.awp?fields=all&amp;filters=%09company%09%5B=%09test%09%0AOR%09company%09%5B=%09centrix%09<\/li>\n<\/ul>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-group faq-frame faq\"><div class=\"wp-block-group__inner-container is-layout-flow wp-block-group-is-layout-flow\">\n<h2 class=\"wp-block-heading has-medium-font-size\" id=\"h-add-or-edit-contacts\"><strong>Add or edit contacts<\/strong><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Same URL as reading except with a POST request and a JSON with the same structure as the read one. (A &#8220;Contacts&#8221; table that contains a &#8220;ContactScript&#8221; table in each contact)<\/li>\n\n\n\n<li>The value &#8220;BaseFilter&#8221; of the URL is ignored in this case, but you still have to specify one. Ex .: &#8220;C&#8221; for contact, it does not matter.<\/li>\n\n\n\n<li>If a field is not received, its value is not changed. If it is received empty, it will be replaced by the empty value.<\/li>\n\n\n\n<li>The values of the fields of type &#8220;account&#8221; will be replaced in all the contacts of the same account. (Everything that appears in the &#8220;Account&#8221; tabs in Centrix)<\/li>\n\n\n\n<li>If &#8220;idc&#8221; is specified, the contact will be changed.<\/li>\n\n\n\n<li>If &#8220;idc&#8221; is not specified and &#8220;ExternalID&#8221; is specified, the contact with this &#8220;ExternalID&#8221; is searched for and modified or created if it is not found.<\/li>\n\n\n\n<li>If neither &#8220;idc&#8221; nor &#8220;ExternalID&#8221; is specified, the contact is created.<\/li>\n\n\n\n<li>In a contact, if a list is specified (&#8220;ids&#8221;), the account and contact information will be changed for this list. If the contact is not a member of this list, he will become a member automatically. It is not possible for the moment to remove a contact from a list by the API. (It&#8217;s possible in Centrix UI)<\/li>\n<\/ul>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-group faq-frame faq\"><div class=\"wp-block-group__inner-container is-layout-flow wp-block-group-is-layout-flow\">\n<h2 class=\"wp-block-heading has-medium-font-size\" id=\"h-links-to-other-centrixone-apis\"><strong>Links to other CentrixOne APIs<\/strong><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Opportunities-Account-APIKey-S9999.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Users-Account-APIKey-all.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/Scripts-Account-APIKey.awp?fields=all (List the contact lists of the account.)<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/RevenueTypes-Account-APIKey-all.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/RevenueTypesSub1-Account-APIKey-all.awp?fields=all<\/li>\n\n\n\n<li>https:\/\/api.centrix.one\/API_WEB\/EN\/RevenueTypesSub2-Account-APIKey-all.awp?fields=all<\/li>\n<\/ul>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Introduction Here is how the CentrixOne CRM API works: How can I obtain my API key and CentrixOne account number? As this information is confidential, you need to send a request by email to support@centrix.one. Our team will validate your identity and the use you will make of this information, then an API key will &#8230; <a title=\"Guide: CentrixOne API\" class=\"read-more\" href=\"https:\/\/www.centrix.one\/en\/faq\/system\/centrixone-api\/\" aria-label=\"Read more about Guide: CentrixOne API\">Read more<\/a><\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[1125],"doc_tag":[],"class_list":["post-31933","docs","type-docs","status-publish","hentry","doc_category-system"],"year_month":"2026-10","word_count":922,"total_views":"414","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"name":"","author_nicename":"","author_url":"https:\/\/www.centrix.one\/en\/author\/"},"doc_category_info":[{"term_name":"System","term_url":"https:\/\/www.centrix.one\/en\/faq\/system\/"}],"doc_tag_info":[],"jetpack_sharing_enabled":true,"knowledge_base_info":[],"knowledge_base_slug":[],"_links":{"self":[{"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/docs\/31933","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/comments?post=31933"}],"version-history":[{"count":5,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/docs\/31933\/revisions"}],"predecessor-version":[{"id":40825,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/docs\/31933\/revisions\/40825"}],"wp:attachment":[{"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/media?parent=31933"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/doc_category?post=31933"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.centrix.one\/en\/wp-json\/wp\/v2\/doc_tag?post=31933"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}