Questions tagged [api]

Questions about the CiviCRM API.

Filter by
Sorted by
Tagged with
0
votes
2answers
61 views

How to get contacts in children of a parent group using the API

I have a child groups C and B, each with 20 different contacts in them. Both child groups are in parent group A. I need to find all contacts in all children of A since C and B might be removed later ...
0
votes
2answers
56 views

condition on count from chained api call

I am trying to use the api to get all contacts without an address with locationtype billing. For this I use the contact get api, and do a chained address get call. Is there a way to put a condition on ...
2
votes
2answers
102 views

Is there a problem with the REST interface on CiviCRM API?

I have the CiviCRM API REST interface working fine for retrieving Case information for individual cases. But I'd like to use the options features options.limit and options.offset so I can retrieve ...
0
votes
1answer
22 views

API Contributions and Payments

I'm using the API to create Contacts start Memberships through a signup form. We are offering 1-year memberships at various price points, and I have those set up in CiviMember. My code successfully ...
1
vote
0answers
24 views

Related membership gets deleted upon updating owner membership via API

I would like to make several people a member, linked to 1 payment person A: membership (+ contribution) person B: membership (related to membership person A) $contact_a = 2; $contact_b = 3; $...
1
vote
0answers
15 views

Create API not updating database in new extension - what have I missed?

Help, built new extension, form displays, accepts input, but never updates the database The returns I get from all functions do not show errors. What the heck am I doing wrong???? It's going to be ...
1
vote
1answer
16 views

Using CIVICRM API can I get both mobile and phone number?

I am trying to work out how to call both a phone number and a mobile number using the API. I am in civicrm/api and can get one or the other but not both. Can anyone suggest a solution!? Thanks ...
3
votes
1answer
31 views

Documentation for new sms provider?

I use NowSMS for my SMS provider instead of Twilio and Clickatell. NowSMS goes through a cell phone, which is flat rate pricing instead of per text. I've found documentation for twilio or clickatell, ...
2
votes
1answer
16 views

Retrieve Contacts with Tags in API4

I am creating some custom directory screens to display a table of contacts with associated email addresses and any tags (just a simplified directory for non-admin staff to view/sort basic CRM data). ...
2
votes
2answers
47 views

How to get data via relationships with APIv4?

Wilma has relationship: is campaigner at organisation System Change Not Charity. How can I get a list of individuals like Wilma and the organisations that they are campaigners for? I've read the ...
1
vote
1answer
16 views

API Explorer 4 under Joomla and Windows/IIS gives fields like {{ ts('CiviCRM API v4') }}

I am running a development system under Joomla and IIS with CiviCRM 5.19.1 (5.19.0 had the same issue). When using API Explorer 4 I get windows like this. Under LAMP, the window makes sense. Any ...
2
votes
0answers
9 views

API: Update a specific multi value field set record

I created a custom field set with three fields, the field set does allow multiple records. The aim of this field set is to collect data about candidacies and mandates of politicians, such as the ...
1
vote
1answer
23 views

Unable to list groups with CiviCRM API

When I run the API command (via CiviCRM API Explorer) to list all the "Mailing Lists" i.e. $result = civicrm_api3('Group', 'get', ['group_type' => "Mailing List"]); I get the full list of mailing ...
1
vote
1answer
23 views

Does the CiviCRM API comply with the OpenAPI Specification?

Does the CiviCRM API comply with the OpenAPI Specification?
3
votes
0answers
18 views

API4 authorization failure when creating a participant

I am currently trying to create a participant on a Drupal form submit, when i do this I get an error saying Authorization failed. I've tried managing the ACLs in Civi with no success, I've also ...
3
votes
3answers
389 views

How to set a default value for a custom field

EDIT: this is done automatically by CiviCRM from 5.18+ I have a custom fieldset on Contributions that uses an option list. The option list has a default value set, but when contributions are created ...
0
votes
2answers
45 views

CiviCRM 5.13.1 API v3 Merge not working

The merge API was worked on 5.0 version but after upgrade to 5.13.1 the merge is Stopped working. Any help is very appreciate.
0
votes
0answers
17 views

Help with Custom Function

I want to create a button that i can click that create relationships for the employee if the Employer has a relationship. So if "Employer 1" has a relationship then all Employees of Employer 1 will ...
2
votes
3answers
46 views

REST API, iATS: How do I create a membership through the API without using CiviCRM's forms?

I'm building a software system that uses CiviCRM as a membership database and a billing engine for recurring dues. Our members do not have direct access to CiviCRM or the server on which it runs, and ...
1
vote
1answer
48 views

Fetch membership type along with the contact details with civicrm_api

I am trying to create a lists of contact along with the membership type associated with each contact. Below is the code I have: $result = civicrm_api3('Contact', 'get', array( 'sequential' => ...
1
vote
1answer
30 views

Guidance Needed on using CiviCRM API + PayPal to Complete Membership Contribution Payment

I'm at a total loss on how to make this work. I am using the CiviCRM API to create a contact, create a membership for that contact, and even create a contribution if that person selects check, ...
0
votes
1answer
33 views

DB Error when using dupe_check in rest API

On version 5.6.0, using api v3. Not sure if something recently changed in our environment, but as of a couple of days ago, running the contact create api (via rest or the explorer) causes a "DB Error: ...
4
votes
1answer
34 views

Smarty only generating nulls from API calls

Using the Explorer, I built up the smarty code I need for a template to pull in address information on a contact for use in an email: {crmAPI var='result' entity='Address' action='get' contact_id=203}...
2
votes
1answer
79 views

Why won't CRM.loadForm render url containing civicrm/a/#?

This call: CRM.loadForm(CRM.url('civicrm/a/#/tournament')); works very well for any url that does NOT contain 'civicrm/a/#'. As soon as I try to open anything from an extension, the popup stays '...
1
vote
1answer
39 views

React with CiviCRM APIs

I am trying to use the CiviCRM APIs from my React application. Which API methods would be the one recommended or easy to do with React application ? The easiest would be REST but since my page and ...
1
vote
2answers
38 views

API problem regarding to Word Replacement

I want to replace a word. I was trying to insert using API3 but it is not working properly. Word replacement API3 $result = civicrm_api3('WordReplacement', 'create', [ 'find_word' => "...
2
votes
1answer
36 views

API call for ACL roles no longer works

I have an API call to get ACL roles that worked before I upgraded to 4.7.29 (I think I was at 4.7.22). Now, this returns no results: $entity_id = $group["id"]; $apiParams = array("entity_id" =...
1
vote
1answer
28 views

Get a field label instead of value using the api

I would like to retrieve both the value as well as the label from a custom field using the api, but it only seems possible to retrieve the value. I wonder if this is possible, would surely help me a ...
0
votes
1answer
21 views

Relative date filter possible in api?

I was wondering if it is possible to use (custom) relative date filters with the api? For instance to find all participants of events in the current or last fiscal year. Would save me a lot of ...
0
votes
1answer
33 views

Does CiviMobileAPI generate any logs?

I enabled CiviMobileAPI extension and Civi CRM Api Fix plug in (I'm using Wordpress) but can't login in the CiviMobile app (iOS). It keeps showing the Server API Error (Unknown error) message. I ...
2
votes
2answers
72 views

Add dupe check parameter to an API call - Contact Form 7 plugin

I've installed the Contact Form 7 CiviCRM integration plugin, and it works fine. I'm just wondering how to add a dupe_check parameter. If I try something like: contact_type=Individual&source=...
1
vote
1answer
13 views

How do I create default custom data when changing contact subtypes via the API?

If I use the API to give someone a new contact subtype it doesn't create a row in any relevant custom data tables and populate the default values. Does anyone have a good way to handle this? I have ...
1
vote
1answer
33 views

Attachment URLs incomplete on remote server only

I'm working locally on my Mac with the latest version of CiviCRM on latest WordPress, served by MAMP. Using the API, I create an attachment to a contact, and those attachments successfully display ...
1
vote
2answers
19 views

How do i properly include civicrm.settings.php to use api calls?

Quite a long time ago I wrote an external script that does this at the top: require_once '/path/to/joomla/install/com_civicrm/civicrm.settings.php'; require_once '/path/to/joomla/install/civicrm/CRM/...
2
votes
3answers
169 views

post hook edit entity

We have a post hook that sends some data to an external api when a participant is created or edited. function kavo_civicrm_post($op, $objectName, $objectId, &$objectRef) { if (($op == 'create' |...
6
votes
2answers
131 views

Get URL of custom image field

I would like to display pictures which are defined as custom "File" fields within an event. I currently to this by generating URLs having the following format: MY_URL?q=civicrm/file&reset=1&...
2
votes
0answers
25 views

Custom API not recognized by explorer/cv

I'm troubleshooting an issue where some custom APIs (v3) via an extension are not recognized by the site, either in the API explorer or when attempting to run them via cv. The situation is puzzling: ...
5
votes
2answers
414 views

CiviCRM integration with Eventbrite

I would like to create/update events in CiviEvent by using Eventbrite webhooks. One of the requirements is having an endpoint page that will receive data sent by Eventbrite API. How can I create that ...
2
votes
0answers
34 views

API v3 Include Some Tags and Exclude Others

I can do a custom search on Contacts to include those with a list of tags, and exclude those that also have an additional tag. And I get the results I expect. I can't for the life of me figure out ...
1
vote
1answer
38 views

Attachment API File Upload

I'm working on a file upload of an image with a registration form. The file is being passed to PHP correctly, and I can check its properties in the $_FILES variable. I used the API Explorer to get the ...
0
votes
1answer
18 views

how do I count results in API v4

experimenting with refactoring some old code and figured I would experiment with apiv4. the first hurdle was figuring out how to use the ArrayObject that is returned. in apiv3, for example I would ...
1
vote
2answers
23 views

`json` parameter in the request API

The parameters in the API are confusing, especially the depth + the json paramter. I have seen these three combinations and my question is, which variant is wrong and which is not. I can't figure ...
4
votes
1answer
631 views

REST API without JSON just key=value

Is it possible to structure /sites/all/modules/civicrm/extern/rest.php?entity=Activity&action=create&json={"sequential":1,"activity_date_time":"2015-09-01","id":2,"subject":"test","target_id":...
1
vote
2answers
38 views

How to use PDF API in production?

(This post is following a previous question I asked and is related to ErikH's answer: https://civicrm.stackexchange.com/a/31142/6991) Context: I want to send per email an attached amended certificate ...
2
votes
1answer
363 views

Where is the API key?

We want to connect CiviCRM with our payment processor (Twingle). We need to find the API key, the site key and the URL of the CiviCRM instance, but we can't seem to find them. Where can we find them?
0
votes
1answer
33 views

Sharing data betweeen Multiple Databases

We have a main organisation with civi multi-site build but finding it a little complex in terms of granting permissions for various sub departments. Thee are also clashes over mailings and issues with ...
1
vote
1answer
22 views

Why no Member entity in the API v4 Explorer

I can't see Member or MembershipType in the API Explorer, nor can I see support for these entities in the API code. As these are pretty crucial I must be missing something - can anyone help?
0
votes
0answers
16 views

Hook to change names of reccuring events

I am going to shut my other question and try and rewrite more clearly here. I have recurring events. I want to change the name of these recurring events to add the date to them, so each one is easily ...
3
votes
3answers
680 views

API Get Contacts which are members of a certain group

While trying this request $result = civicrm_api3('Contact', 'get', array( 'return' => "id", 'group' => "Administrators", )); we've got { "error_code": "no such field", "sql": "...
2
votes
1answer
42 views

Updating Memo/Rich Text Editor Fields with the API

I have in my CiviCRM a custom field which is a memo field with a text editor. If I update the contents of this field through the user interface contents is saved correctly as html. E.g. <p>Hello ...